This repository has been archived by the owner on Oct 18, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move Development from README to CONTRIBUTING
- Loading branch information
1 parent
ca2a835
commit 2115f7f
Showing
2 changed files
with
42 additions
and
15 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 |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Development | ||
|
||
This project is managed using [Poetry](https://python-poetry.org), a fantastic Python packaging and dependency manager. | ||
Install the latest version of Poetry before continuing. Development requires Python 3.7+. | ||
|
||
## Set up | ||
|
||
Starting from Zero? Not sure where to begin? Here's steps on setting up this Python project using Poetry. Note that | ||
Poetry installation instructions should be followed from the Poetry Docs: https://python-poetry.org/docs/#installation | ||
|
||
1. While optional, It's recommended to configure Poetry to install Virtual environments within project folders: | ||
```shell | ||
poetry config virtualenvs.in-project true | ||
``` | ||
This makes it easier for Visual Studio Code to detect the Virtual Environment, as well as other IDEs and systems. | ||
I've also had issues with Poetry creating duplicate Virtual environments in the default folder for an unknown | ||
reason which quickly filled up my System storage. | ||
2. Clone the Repository: | ||
```shell | ||
git clone https://github.com/rlaphoenix/pynfogen | ||
cd pynfogen | ||
``` | ||
3. Install the Project with Poetry: | ||
```shell | ||
poetry install | ||
``` | ||
This creates a Virtual environment and then installs all project dependencies and executables into the Virtual | ||
environment. Your System Python environment is not affected at all. | ||
4. Now activate the Virtual environment: | ||
```shell | ||
poetry shell | ||
``` | ||
Note: | ||
- You can alternatively just prefix `poetry run` to any command you wish to run under the Virtual environment. | ||
- I recommend entering the Virtual environment and all further instructions will have assumed you did. | ||
- JetBrains PyCharm has integrated support for Poetry and automatically enters Poetry Virtual environments, assuming | ||
the Python Interpreter on the bottom right is set up correctly. | ||
- For more information, see: https://python-poetry.org/docs/basic-usage/#using-your-virtual-environment | ||
5. Install Pre-commit tooling to ensure safe and quality commits: | ||
```shell | ||
pre-commit install | ||
``` |
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