Skip to content

Commit c796e84

Browse files
committed
update readme
1 parent cb13093 commit c796e84

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@ Pyvec homepage.
44

55
## Installation
66

7-
The code is **Python 3.9**
7+
The code is **Python 3.14**
88

99
```sh
10-
$ pipenv install
10+
$ uv sync
1111
```
1212

1313
## Development
1414

1515
The site uses [elsa](https://github.com/pyvec/elsa).
1616

17-
- Installation: `pipenv install --dev`
18-
- Download data from external sources: `pipenv run build`
19-
- Tests: `pipenv run test`
20-
- Development server: `pipenv run serve`
17+
- Installation: `uv sync`
18+
- Download data from external sources: `uv run python -m pyvecorg build`
19+
- Tests: `uv run pytest`
20+
- Development server: `uv run python -m pyvecorg serve`
2121

2222
### Data and tests
2323

@@ -39,21 +39,21 @@ logical rules which cannot be easily expressed by JSON Schema.
3939
### External sources
4040

4141
Some data cannot be stored statically in a YAML file. There is a command
42-
`pipenv run build`, which downloads them from external sources and generates
42+
`uv run python -m pyvecorg build`, which downloads them from external sources and generates
4343
respective static YAML files. This is a separate step, which needs to be done
4444
before developing or deploying the site, otherwise it won't work properly.
4545

4646
### Members
4747

4848
Pyvec members are tracked in an internal Google Spreadsheet. The future
4949
intention is to have the list of members public, but we're not there yet (GDPR).
50-
So far only board members are being listed publicly. The `pipenv run build`
50+
So far only board members are being listed publicly. The `uv run python -m pyvecorg build`
5151
command downloads the spreadsheet as CSV and generates the `members_list.yml`
5252
file. It also downloads and caches avatars.
5353

5454
### Numbers
5555

56-
There are stats numbers in [numbers.yml](pyvecorg/data/numbers.yml). They are
56+
There are stats numbers in [numbers.yml](src/pyvecorg/data/numbers.yml). They are
5757
not calculated on the fly, because for many of them it's either complicated
5858
or impossible. They need to be updated manually from time to time. Comments
5959
in the YAML file should give you guidance on when the last update has happened.
@@ -71,7 +71,7 @@ the number,
7171
1. Follow the steps in the [gspread guide](https://gspread.readthedocs.io/en/latest/oauth2.html). Instead of Google Drive API, enable Google Sheets API.
7272
1. Save the obtained JSON file into the `pyvecorg` package as `google_service_account.json`
7373
1. Make sure it is ignored by Git
74-
1. Run `cat pyvecorg/google_service_account.json | pbcopy` to copy the JSON into your clipboard (macOS)
74+
1. Run `cat src/pyvecorg/google_service_account.json | pbcopy` to copy the JSON into your clipboard (macOS)
7575
1. Go to [settings of secrets](https://github.com/pyvec/pyvec.org/settings/secrets)
7676
1. Add `GOOGLE_SERVICE_ACCOUNT` secret and paste the JSON from your clipboard as a value
7777

0 commit comments

Comments
 (0)