| Name | blank-project JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | None |
| Summary | A dummy package for quickly starting typical Python projects. |
| upload_time | 2024-10-27 16:01:37 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
utility
dummy package
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# blank-project
[](https://pepy.tech/project/blank-project)
A dummy package for quickly starting typical Python projects.
Features:
* Basic `.gitignore`;
* GitHub actions for builds and checks;
* Acceptable directory structure at once;
* Regular automation based on a `Makefile`;
* Templates for basic Python badges into `README.md`.
* Single point of project specification - `pyproject.toml`;
* Acceptable settings for: `black`, `isort`, `flake8`, `mypy`, `pydocstyle` and `coverage`;
## Usage
1. Clone repo:
```shellsession
$ git clone https://git.peterbro.su/peter/py3-blank-project.git
```
2. Run **init.sh** with your project name:
```shellsession
$ cd py3-blank-project
$ NAME=<projname> \
VERSION=<version|0.1.0> \
AUTHOR=<name> \
EMAIL=<author email> \
LICENSE=<license|MIT> \
./init.sh && cd -P .
```
3. Change `description`, `keywords` and `classifiers` into **pyproject.toml**.
4. Change `README.md` and `LICENSE` files.
A new blank Python project is ready, create gh-repo and go forward!
## Available make commands
### Dependencies
- `make deps-dev` - Install only development dependencies.
- `make deps-build` - Install only build system dependencies.
- `make deps` - Install all dependencies.
### Distributing
- `make build-sdist` - Build a source distrib.
- `make build-wheel` - Build a pure Python wheel distrib.
- `make build` - Build both distribs (source and wheel).
- `make upload` - Upload built packages to PyPI.
### Development
- `make cleanup` - Clean up Python temporary files and caches.
- `make format` - Fromat the code (by black and isort).
- `make lint` - Check code style, docstring style and types (by flake8, pydocstyle and mypy).
- `make tests` - Run tests with coverage measure (output to terminal).
- `make tests-cov-json` - Run tests with coverage measure (output to json [coverage.json]).
- `make tests-cov-html` - Run tests with coverage measure (output to html [coverage_report/]).
Raw data
{
"_id": null,
"home_page": null,
"name": "blank-project",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "utility, dummy package",
"author": null,
"author_email": "Peter Bro <p3t3rbr0@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/dc/99/c1b21e356cdc068e454e664295aa9b30c33fcdf5e189c3f273f4ec3de3c2/blank_project-0.3.1.tar.gz",
"platform": null,
"description": "# blank-project\n\n\n\n\n[](https://pepy.tech/project/blank-project)\n\n\nA dummy package for quickly starting typical Python projects.\n\nFeatures:\n\n* Basic `.gitignore`;\n* GitHub actions for builds and checks;\n* Acceptable directory structure at once;\n* Regular automation based on a `Makefile`;\n* Templates for basic Python badges into `README.md`.\n* Single point of project specification - `pyproject.toml`;\n* Acceptable settings for: `black`, `isort`, `flake8`, `mypy`, `pydocstyle` and `coverage`;\n\n## Usage\n\n1. Clone repo:\n\n```shellsession\n$ git clone https://git.peterbro.su/peter/py3-blank-project.git\n```\n\n2. Run **init.sh** with your project name:\n\n```shellsession\n$ cd py3-blank-project\n$ NAME=<projname> \\\n VERSION=<version|0.1.0> \\\n AUTHOR=<name> \\\n EMAIL=<author email> \\\n LICENSE=<license|MIT> \\\n ./init.sh && cd -P .\n```\n\n3. Change `description`, `keywords` and `classifiers` into **pyproject.toml**.\n\n4. Change `README.md` and `LICENSE` files.\n\nA new blank Python project is ready, create gh-repo and go forward!\n\n## Available make commands\n\n### Dependencies\n\n- `make deps-dev` - Install only development dependencies.\n- `make deps-build` - Install only build system dependencies.\n- `make deps` - Install all dependencies.\n\n### Distributing\n\n- `make build-sdist` - Build a source distrib.\n- `make build-wheel` - Build a pure Python wheel distrib.\n- `make build` - Build both distribs (source and wheel).\n- `make upload` - Upload built packages to PyPI.\n\n### Development\n\n- `make cleanup` - Clean up Python temporary files and caches.\n- `make format` - Fromat the code (by black and isort).\n- `make lint` - Check code style, docstring style and types (by flake8, pydocstyle and mypy).\n- `make tests` - Run tests with coverage measure (output to terminal).\n- `make tests-cov-json` - Run tests with coverage measure (output to json [coverage.json]).\n- `make tests-cov-html` - Run tests with coverage measure (output to html [coverage_report/]).\n",
"bugtrack_url": null,
"license": null,
"summary": "A dummy package for quickly starting typical Python projects.",
"version": "0.3.1",
"project_urls": {
"Changelog": "https://git.peterbro.su/peter/py3-blank-project/src/branch/master/CHANGELOG.md",
"Documentation": "https://git.peterbro.su/peter/py3-blank-project/src/branch/master/README.md",
"Homepage": "https://git.peterbro.su/peter/py3-blank-project",
"Issues": "https://git.peterbro.su/peter/py3-blank-project/issues",
"Repository": "https://git.peterbro.su/peter/py3-blank-project.git"
},
"split_keywords": [
"utility",
" dummy package"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "73f8f08464bb962cf9126604cb4b64c2ea1d2332ecdac0dd49880d90c5a75e9d",
"md5": "0c1958314d816b774aac1ecdee117035",
"sha256": "326c4c1f37d21df4b5c9ac7ce9e781b512747260a3a3df1e858b16bc0c70651e"
},
"downloads": -1,
"filename": "blank_project-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0c1958314d816b774aac1ecdee117035",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 3625,
"upload_time": "2024-10-27T16:01:36",
"upload_time_iso_8601": "2024-10-27T16:01:36.427486Z",
"url": "https://files.pythonhosted.org/packages/73/f8/f08464bb962cf9126604cb4b64c2ea1d2332ecdac0dd49880d90c5a75e9d/blank_project-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dc99c1b21e356cdc068e454e664295aa9b30c33fcdf5e189c3f273f4ec3de3c2",
"md5": "57b4dfc1ec74a9f3e4a7f7313ce89c04",
"sha256": "3c1f5a27ef38ad4d8cb603ef51bb139290cf9ddeda58ca811850ba2d5540367f"
},
"downloads": -1,
"filename": "blank_project-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "57b4dfc1ec74a9f3e4a7f7313ce89c04",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 3952,
"upload_time": "2024-10-27T16:01:37",
"upload_time_iso_8601": "2024-10-27T16:01:37.466060Z",
"url": "https://files.pythonhosted.org/packages/dc/99/c1b21e356cdc068e454e664295aa9b30c33fcdf5e189c3f273f4ec3de3c2/blank_project-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-27 16:01:37",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "blank-project"
}
