Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Poetry contributing #507

Merged
merged 2 commits into from
Jun 13, 2024
Merged

Docs: Poetry contributing #507

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e37309
add info on poetry installation
s3alfisc Jun 13, 2024
ad37818
add details on just
s3alfisc Jun 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion docs/contributing.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,26 @@ scoop bucket add extras
scoop install extras/quarto
```

### Package Management

`PyFixest` is using [poetry](https://github.com/python-poetry/poetry).

Please follow the [installation instructions](https://python-poetry.org/docs/#installing-with-the-official-installer) from the poetry documentation.

Afterwards, you can initiate the project environment and install all dependencies by running

```{bash}
cd path-to-pyfixest
poetry install
```

If you type
```{bash}
poetry shell
```

you will see that you have activated a custom poetry environment for pyfixest.

### Code Style

We use `ruff` and `pre-commit` to ensure a consistent code style.
Expand All @@ -141,7 +161,8 @@ and you're ready to go!

There are several command line targets that assist with development included in the
`justfile`. [Just](https://just.systems/) can be installed to help run these
command line targets.
command line targets. Installing `just` is only recommended and not needed for
development of pyfixest.

On Mac/Linux via [Homebrew](https://formulae.brew.sh/formula/just#default):

Expand Down
Loading