mirror of
https://github.com/Garmelon/PFERD.git
synced 2023-12-21 10:23:01 +01:00
27e4abcfa3
Following guidelines from the Python Packaging User Guide [1]. This commit intentionally breaks the .gitignore, project dependencies, GitHub Actions and other stuff. It also removes almost the entire README. The intention behind this is to get rid of all cruft that as accumulated over time and to have a fresh start. Only necessary things will be re-added as they're needed. From now on, I also plan on adding documentation for every feature at the same time that the feature is implemented. This is to ensure that the documentation does not become outdated. [1]: https://packaging.python.org/
38 lines
1.5 KiB
Markdown
38 lines
1.5 KiB
Markdown
# PFERD Development Guide
|
|
|
|
PFERD is packaged following the [Python Packaging User Guide][ppug] (in
|
|
particular [this][ppug-1] and [this][ppug-2] guide).
|
|
|
|
[ppug]: <https://packaging.python.org/> "Python Packaging User Guide"
|
|
[ppug-1]: <https://packaging.python.org/tutorials/packaging-projects/> "Packaging Python Projects"
|
|
[ppug-2]: <https://packaging.python.org/guides/distributing-packages-using-setuptools/> "Packaging and distributing projects"
|
|
|
|
## Setting up a dev environment
|
|
|
|
The use of [venv][venv] is recommended. To initially set up a development
|
|
environment, run these commands in the same directory as this file:
|
|
|
|
```
|
|
$ python -m venv .venv
|
|
$ . .venv/bin/activate
|
|
$ pip install --editable .
|
|
```
|
|
|
|
After this, you can use PFERD as if it was installed normally. Since PFERD was
|
|
installed with `--editable`, there is no need to re-run `pip install` when the
|
|
source code is changed.
|
|
|
|
For more details, see [this part of the Python Tutorial][venv-tut] and
|
|
[this section on "development mode"][ppug-dev].
|
|
|
|
[venv]: <https://docs.python.org/3/library/venv.html> "venv - Creation of virtual environments"
|
|
[venv-tut]: <https://docs.python.org/3/tutorial/venv.html> "12. Virtual Environments and Packages"
|
|
[ppug-dev]: <https://packaging.python.org/guides/distributing-packages-using-setuptools/#working-in-development-mode> "Working in “development mode”"
|
|
|
|
## Contributing
|
|
|
|
When submitting a PR that adds, changes or modifies a feature, please ensure
|
|
that the corresponding documentation is updated.
|
|
|
|
In your first PR, please add your name to the `LICENSE` file.
|