Skip to content

Commit ffb2d60

Browse files
committed
chore: update readme and drop requirements.txt
1 parent 2b1097d commit ffb2d60

2 files changed

Lines changed: 17 additions & 95 deletions

File tree

‎README.md‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Mappings below are supported by both `woc.get_values` and `woc.objects`:
2323
And objects:
2424

2525
```python
26-
['commit', 'tree', 'blob']
26+
['commit', 'tree', 'blob', 'tag']
2727
```
2828

2929
If you are still unsure what characters in the mappings mean, checkout the [WoC Tutorial](https://github.com/woc-hack/tutorial?tab=readme-ov-file#activity-3---investigate-the-maps).
@@ -46,17 +46,30 @@ pip3 install python-woc
4646

4747
### From Source
4848

49-
To try out latest features, you may install python-woc from source:
49+
You can also install `python-woc` from source. First, clone the repository:
5050

5151
```bash
5252
git clone https://github.com/ssc-oscar/python-woc.git
5353
cd python-woc
54-
python3 -m pip install -r requirements.txt
55-
python3
54+
```
55+
56+
We use poetry as the package manager. You can install it with:
57+
58+
```bash
59+
curl -sSL https://install.python-poetry.org | python3 -
60+
```
61+
62+
Then install the dependencies and the package:
63+
64+
```bash
65+
poetry install
5666
```
5767

5868
## Generate Profiles
5969

70+
> [!NOTE]
71+
> If you are on UTK/PKU WoC servers, you can skip this step. Profiles are already generated and available at `/home/wocprofile.json` or `/etc/wocprofile.json`.
72+
6073
One of the major improvents packed in python-woc is profile. Profiles tell the driver what versions of what maps are available, decoupling the driver from the folder structure of the data. It grants the driver the ability to work with multiple versions of WoC, on a different machine, or even on the cloud.
6174

6275
Profiles are generated using the `woc.detect` script. The script takes a list of directories, scans for matched filenames, and generates a profile:

‎requirements.txt‎

Lines changed: 0 additions & 91 deletions
This file was deleted.

0 commit comments

Comments
 (0)