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 contributing docs to README #224

Open
wants to merge 1 commit into
base: master
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ __pycache__
*.sublime-*
.venv
.vscode
.idea

granian/*.so
target/*
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ A Rust HTTP server for Python applications.
The main reasons behind Granian design are:

- Have a single, correct HTTP implementation, supporting versions 1, 2 (and eventually 3)
- Provide a single package for several platforms
- Provide a single package for several platforms
- Avoid the usual Gunicorn + uvicorn + http-tools dependency composition on unix systems
- Provide stable [performance](https://github.com/emmett-framework/granian/blob/master/benchmarks/README.md) when compared to existing alternatives

Expand Down Expand Up @@ -215,6 +215,28 @@ Granian is currently under active development.

Granian is compatible with Python 3.8 and above versions.

### Contributing

Create a virtual environment and install:

```shell
pip install .[hacking]
```

On zsh, you may need to do: `.\[hacking\]` instead of `.[hacking]`

To finalize setup, run:

```shell
pre-commit install
```

To edit rust files, first install Rust if you haven't. Then compile the project:

```shell
maturin develop
```

## License

Granian is released under the BSD License.
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ test = [
]
all = ['granian[pname,reload]']
dev = ['granian[all,lint,test]']
hacking = ['granian[dev]', 'maturin', 'pre-commit']

[project.urls]
Homepage = 'https://github.com/emmett-framework/granian'
Expand Down