Skip to content

Commit

Permalink
Add initial development instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
emmiegit committed Jan 10, 2024
1 parent ed2a616 commit b925e2b
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Runtime configuration
config*.toml
!config.example.toml

# Python artifacts
__pycache__/
*.py[cod]
Expand Down
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,21 @@ $ source env/bin/activate
$ pip install -r requirements.txt
```

Then when doing development, install the development dependencies and then run linting to ensure things are in order:

```
$ pip install -r requirements.dev.txt
$ black bzhr
$ isort bzhr
$ mypy bzhr
```

Then, to run a local instance, create a `config.toml` file (see `config.example.toml` as an example) and run:

```
$ python -m bzhr config.toml
```

If you are packaging for a production deployment, the easiest method is to build a Docker image and ship that:

```
Expand Down

0 comments on commit b925e2b

Please sign in to comment.