Skip to content

Update contribution notes to install with pip instead of Flit #49

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

Merged
merged 1 commit into from
Nov 8, 2022
Merged

Update contribution notes to install with pip instead of Flit #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 9 additions & 13 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,24 +26,20 @@ Do you want to contribute code to `codetiming`? Fantastic! We welcome contributi

## Setting Up Your Environment

`codetiming` uses [`flit`](https://flit.readthedocs.io) for package management. You should first install `flit`:
`codetiming` uses [`flit`](https://flit.readthedocs.io) for package management. You can use `flit` through [`pip`](https://realpython.com/what-is-pip/).

```
$ python -m pip install flit
```

You can then install `codetiming` locally for development with `flit`:
You can then install `codetiming` locally for development with `pip`:

```
$ python -m flit install --pth-file --deps all
$ python -m pip install --editable .[dev,test]
```

This will install `codetiming` and all its dependencies, including development tools like [`black`](https://black.readthedocs.io) and [`mypy`](http://mypy-lang.org/). The `--pth-file` option allows you to test your changes without reinstalling. On Linux and Mac, you can use `--symlink` for the same effect.
This will install `codetiming` and all its dependencies, including development tools like [`black`](https://black.readthedocs.io) and [`mypy`](http://mypy-lang.org/), and test runners like [`pytest`](https://docs.pytest.org/). The `--editable` option allows you to test your changes without reinstalling.


## Running Tests

Run tests using [`tox`](https://tox.readthedocs.io/). `tox` helps to enforce the following principles:
Run tests using [`tox`](https://tox.readthedocs.io/). You can also run individual tests manually. `tox` helps to enforce the following principles:

- Consistent code style using [`black`](https://black.readthedocs.io). You can automatically format your code as follows:

Expand All @@ -62,10 +58,10 @@ Run tests using [`tox`](https://tox.readthedocs.io/). `tox` helps to enforce the
- Unit testing using [`pytest`](https://docs.pytest.org/). You can run your tests and see a coverage report as follows:

```console
$ pytest --cov=codetiming --cov-report=term-missing
$ python -m pytest --cov=codetiming --cov-report=term-missing
```

- Code issues are checked with the [flake8]() linter. You can run flake8 manually as follows:
- Code issues are checked with the [flake8](https://flake8.pycqa.org/) linter. You can run flake8 manually as follows:

```console
$ python -m flake8 codetiming/ tests/
Expand All @@ -80,7 +76,7 @@ Run tests using [`tox`](https://tox.readthedocs.io/). `tox` helps to enforce the
- All modules, functions, classes, and methods must have docstrings. This is enforced by [Interrogation](https://interrogate.readthedocs.io/). You can test compliance as follows:

```console
$ interrogate -c pyproject.toml -vv
$ python -m interrogate -c pyproject.toml -vv
```

Feel free to ask for help in your PR if you are having challenges with any of these tests.
Feel free to ask for help in your PR if you are having challenges with any of these tests.