# yhttp
[](https://pypi.python.org/pypi/yhttp)
[](https://github.com/yhttp/yhttp/actions/workflows/build.yml)
[](https://coveralls.io/github/yhttp/yhttp?branch=master)
[](https://yhttp.github.io/yhttp)
[](https://python.org)
[Documentation](https://yhttp.github.io/yhttp)
## Contribution
### python-makelib
Install [python-makelib](https://github.com/pylover/python-makelib).
### Clone
```bash
git clone --recurse-submodules git@github.com:yhttp/yhttp.git
```
### Virtualenv
Create virtual environment:
```bash
make venv
```
Delete virtual environment:
```bash
make venv-delete
```
Activate the virtual environment:
```bash
source ./activate.sh
```
### Install (editable mode)
Install this project as editable mode and all other development dependencies:
```bash
make env
```
### Tests
Execute all tests:
```bash
make test
```
Execute specific test(s) using wildcard:
```bash
make test F=tests/test_db*
make test F=tests/test_form.py::test_querystringform
```
*refer to* [pytest documentation](https://docs.pytest.org/en/7.1.x/how-to/usage.html#how-to-invoke-pytest)
*for more info about invoking tests.*
Execute tests and report coverage result:
```bash
make cover
make cover F=tests/test_static.py
make cover-html
```
# Lint
```bash
make lint
```
### Distribution
Execute these commands to create `Python`'s standard distribution packages
at `dist` directory:
```bash
make sdist
make wheel
```
Or
```bash
make dist
```
to create both `sdidst` and `wheel` packages.
### Clean build directory
Execute:
```bash
make clean
```
to clean-up previous `dist/*` and `build/*` directories.
### PyPI
> **_WARNING:_** Do not do this if you'r not responsible as author and
> or maintainer of this project.
Execute
```bash
make clean
make pypi
```
to upload `sdists` and `wheel` packages on [PyPI](https://pypi.org).
## Documentation
```bash
make doc
make livedoc
make doctest
```
Or
```bash
cd sphinx
make doctest
make html
make livehtml
```
Raw data
{
"_id": null,
"home_page": "http://github.com/yhttp/yhttp",
"name": "yhttp",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Vahid Mardani",
"author_email": "vahid.mardani@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2b/a6/ace655b72cc997d38b78f925f8c3cc91329cf5ba4b9edaa12d21c1bd9ca1/yhttp-6.3.0.tar.gz",
"platform": null,
"description": "# yhttp\n\n[](https://pypi.python.org/pypi/yhttp)\n[](https://github.com/yhttp/yhttp/actions/workflows/build.yml)\n[](https://coveralls.io/github/yhttp/yhttp?branch=master)\n[](https://yhttp.github.io/yhttp)\n[](https://python.org)\n\n[Documentation](https://yhttp.github.io/yhttp)\n\n## Contribution\n\n### python-makelib\nInstall [python-makelib](https://github.com/pylover/python-makelib).\n\n### Clone \n```bash\ngit clone --recurse-submodules git@github.com:yhttp/yhttp.git\n```\n\n### Virtualenv\n\nCreate virtual environment:\n```bash\nmake venv\n```\n\nDelete virtual environment:\n```bash\nmake venv-delete\n```\n\nActivate the virtual environment:\n```bash\nsource ./activate.sh\n```\n\n\n### Install (editable mode)\nInstall this project as editable mode and all other development dependencies:\n```bash\nmake env\n```\n\n\n### Tests\nExecute all tests:\n```bash\nmake test\n```\n\nExecute specific test(s) using wildcard:\n```bash\nmake test F=tests/test_db*\nmake test F=tests/test_form.py::test_querystringform\n```\n\n*refer to* [pytest documentation](https://docs.pytest.org/en/7.1.x/how-to/usage.html#how-to-invoke-pytest)\n*for more info about invoking tests.*\n\nExecute tests and report coverage result:\n```bash\nmake cover\nmake cover F=tests/test_static.py\nmake cover-html\n```\n\n\n# Lint\n```bash\nmake lint\n```\n\n\n### Distribution\nExecute these commands to create `Python`'s standard distribution packages\nat `dist` directory:\n```bash\nmake sdist\nmake wheel\n```\n\nOr \n```bash\nmake dist\n```\nto create both `sdidst` and `wheel` packages.\n\n\n### Clean build directory\nExecute: \n```bash\nmake clean\n```\nto clean-up previous `dist/*` and `build/*` directories.\n\n\n### PyPI\n\n> **_WARNING:_** Do not do this if you'r not responsible as author and \n> or maintainer of this project.\n\nExecute\n```bash\nmake clean\nmake pypi\n```\nto upload `sdists` and `wheel` packages on [PyPI](https://pypi.org).\n\n\n## Documentation\n\n```bash\nmake doc\nmake livedoc\nmake doctest\n```\n\nOr \n\n```bash\ncd sphinx\nmake doctest\nmake html\nmake livehtml\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A very micro http framework.",
"version": "6.3.0",
"project_urls": {
"Homepage": "http://github.com/yhttp/yhttp"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ed97a2225dba8233ec295c03c574b0b1e4554aed54e5f5bda8b80793b6a76808",
"md5": "c6f9835caff923dae4cd9f5014b6edc5",
"sha256": "ab2d456e058554a324c50a81478206da50b88a83a3e917afd636c38089cf8e63"
},
"downloads": -1,
"filename": "yhttp-6.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c6f9835caff923dae4cd9f5014b6edc5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 28358,
"upload_time": "2024-09-01T01:47:31",
"upload_time_iso_8601": "2024-09-01T01:47:31.770723Z",
"url": "https://files.pythonhosted.org/packages/ed/97/a2225dba8233ec295c03c574b0b1e4554aed54e5f5bda8b80793b6a76808/yhttp-6.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2ba6ace655b72cc997d38b78f925f8c3cc91329cf5ba4b9edaa12d21c1bd9ca1",
"md5": "a02dbba520804e7f836de194975ba499",
"sha256": "769274b55b500126b5f0ed0e2c511a50c540f8bad8d227378c905af708f96069"
},
"downloads": -1,
"filename": "yhttp-6.3.0.tar.gz",
"has_sig": false,
"md5_digest": "a02dbba520804e7f836de194975ba499",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 48397,
"upload_time": "2024-09-01T01:47:33",
"upload_time_iso_8601": "2024-09-01T01:47:33.354212Z",
"url": "https://files.pythonhosted.org/packages/2b/a6/ace655b72cc997d38b78f925f8c3cc91329cf5ba4b9edaa12d21c1bd9ca1/yhttp-6.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-01 01:47:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yhttp",
"github_project": "yhttp",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "yhttp"
}
JSON
