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.

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

Add Development Guide #107

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,3 +170,9 @@ Feedback
--------

Open a ticket / fork the project on [GitHub](http://github.com/Infinidat/munch).


Development
--------

See [Development Guide](docs/development.md)
34 changes: 34 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Development Guide

Use python 3.10:

```
pyenv local 3.10
```

Create a virtual environment:

```
python -m venv .env
source .env/bin/activate
```

Install dependencies:

```
pip install --upgrade pip
pip install --upgrade build wheel setuptools pytest
pip install --use-pep517 ".[testing,yaml]"
```

Test:

```
pytest
```

Lint:

```
pylint munch setup.py tests
```