-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4891110
commit e37ef02
Showing
1 changed file
with
7 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,49 +1,11 @@ | ||
# data_viz_pyladies | ||
# 5 science-backed tips for better data visualizations | ||
|
||
An example project | ||
Presentation held at PyLadies meetup 2024-04-18. | ||
|
||
## Development | ||
Figures are created in the notebook. | ||
|
||
Dependencies for the project are managed with poetry. To install all dependencies, run: | ||
Create poetry environment [installing poetry](https://python-poetry.org/docs/#installation) and then running | ||
`poetry install` | ||
|
||
```shell | ||
poetry install | ||
``` | ||
|
||
It's recommended to install and use Pre-commit hooks to ensure code quality. Pre-commit can for | ||
example be installed with pip or [pipx](https://pypa.github.io/pipx/installation/) (recommended): | ||
|
||
It's recommended to install and use Pre-commit hooks to ensure code quality. Pre-commit is one of | ||
the dev-dependencies of this project, so it was installed when you entered the command above, but | ||
the hooks still need to be installed with the following command: | ||
|
||
```shell | ||
poetry run pre-commit install | ||
``` | ||
|
||
After installation, Pre-commit will run a series of checks on each commit. These checks are defined | ||
in `.pre-commit-config.yaml`. If Pre-commit finds an issue, it will usually (depending on the hook) | ||
fix it automatically. You will have to add the changes to the staging area and commit again: | ||
|
||
```shell | ||
git add . | ||
git commit | ||
``` | ||
|
||
Pre-commit can also be run manually: | ||
|
||
```shell | ||
poetry run pre-commit run --all-files | ||
``` | ||
|
||
It's a good idea to update the Pre-commit hooks regularly: | ||
|
||
```shell | ||
poetry run pre-commit autoupdate | ||
``` | ||
|
||
Tests can be run with pytest: | ||
|
||
```shell | ||
poetry run pytest | ||
``` | ||
Launch the notebook in the poetry environment using | ||
`poetry run jupyter lab`. |