معرفی شرکت ها
cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance-0.0.3
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Cookiecutter Cruft Poetry Tox Pre Commit Ci Cd Instance
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance-0.0.3 |
| نام | cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance |
| نسخه کتابخانه | 0.0.3 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | YOUR_FIRST_AND_LAST_NAME |
| ایمیل نویسنده | action@github.com |
| آدرس صفحه اصلی | https://github.com/TeoZosa/cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance |
| آدرس اینترنتی | https://pypi.org/project/cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance/ |
| مجوز | Apache-2.0 |
cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance
==============================
[](https://github.com/pre-commit/pre-commit)
[](https://github.com/psf/black)
[](https://semgrep.dev/)
---
**Documentation**: [https://github.readthedocs.io](https://github.readthedocs.io)
**Source Code**: [https://github.com/TeoZosa/cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance](https://github.com/TeoZosa/cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance)
---
:teacher: Overview
------------------
- TODO
:sparkles: Features
-------------------
- TODO
:information_source: Requirements
---------------------------------
- TODO
------------
Table of Contents
<!-- toc -->
- [:tada: Installation](#tada-installation)
- [:rocket: Usage](#rocket-usage)
* [:children_crossing: Running The Project](#children_crossing-running-the-project)
+ [:one: Docker Container Project Environment (recommended)](#one-docker-container-project-environment-recommended)
+ [:two: Locally via Poetry (development workflow)](#two-locally-via-poetry-development-workflow)
- [:clipboard: Summary](#clipboard-summary)
- [:books: Further Reading](#books-further-reading)
- [:wrench: Development](#wrench-development)
* [:building_construction: Package and Dependencies Installation](#building_construction-package-and-dependencies-installation)
* [:package: Python Module to C-Extension Compilation](#package-python-module-to-c-extension-compilation)
* [:whale: Docker Container Image Building/Deployment Orchestration](#whale-docker-container-image-buildingdeployment-orchestration)
* [:white_check_mark: Testing](#white_check_mark-testing)
* [:rotating_light: Code Quality](#rotating_light-code-quality)
+ [:arrows_counterclockwise: Automate via Git Pre-Commit Hooks](#arrows_counterclockwise-automate-via-git-pre-commit-hooks)
* [:memo: Documentation](#memo-documentation)
- [:judge: Legal](#judge-legal)
* [:page_facing_up: License](#page_facing_up-license)
* [:busts_in_silhouette: Credits](#busts_in_silhouette-credits)
<!-- tocstop -->
:tada: Installation
===================
You can install Cookiecutter Cruft Poetry Tox Pre Commit Ci Cd Instance via [pip](https://pip.pypa.io/):
```shell script
pip install cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance
```
:rocket: Usage
==============
- TODO
- High-level usage overview
------------
- TODO
- Step 0 description
```python
import cookiecutter_cruft_poetry_tox_pre_commit_ci_cd_instance
# TODO
```
> :fire: **Tip**
> All following commands are relative to the project root directory and assume
> `make` is installed.
:children_crossing: Running The Project
----------------------------------------
### :one: Docker Container Project Environment (recommended)
Run:
```shell script
# Uncomment below to run with corresponding options.
# Note: *any* value other than `false` will trigger an option
#export IS_INTERACTIVE_SESSION=true
#export BIND_MOUNT_APPLICATION_DIR_ON_CONTAINER=true
make deploy-project-docker-container
```
which will fetch and run the project container image.
> :fire: **Tip**
> If you prefer to build and run the container locally, run:
> ```shell script
> make deploy-project-docker-container-local
> ```
### :two: Locally via Poetry (development workflow)
Run:
```shell script
make provision-environment # Note: installs ALL dependencies!
poetry shell # Activate the project's virtual environment
```
:clipboard: Summary
===================
- TODO
:books: Further Reading
=======================
- TODO
---
:wrench: Development
====================
For convenience, implementation details of the below processes are abstracted away and
encapsulated in single [Make](https://www.gnu.org/software/make/) targets.
> :fire: **Tip**
> Invoking `make` without any arguments will display
> auto-generated documentation on available commands.
:building_construction: Package and Dependencies Installation
-------------------------------------------------------------
Make sure you have Python 3.8+ and [`poetry`](https://python-poetry.org/)
installed and configured.
To install the package and all dev dependencies, run:
```shell script
make provision-environment
```
> :fire: **Tip**
> Invoking the above without `poetry` installed will emit a
> helpful error message letting you know how you can install Poetry.
:package: Python Module to C-Extension Compilation
--------------------------------------------------
The projects's [build.py](./build.py) file specifies which modules to package.
For manual per-module compilation, see:
[Mypyc Documentation: Getting started - Compiling and running](https://mypyc.readthedocs.io/en/latest/getting_started.html#compiling-and-running)
:whale: Docker Container Image Building/Deployment Orchestration
----------------------------------------------------------------
The following set of `make` targets orchestrate the project's container image build and
deploy steps:
```shell
build-container Build cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance container
deploy-project-docker-container Deploy downloaded dockerized project environment with preloaded dependencies
deploy-project-docker-container-local Deploy locally-built dockerized project environment with preloaded dependencies
pull-container Pull cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance container
push-container Push cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance container
stop-container Stop container forcefully (i.e., when keyboard interrupts are disabled)
```
Note that the project's container image is insulated from the implementation details of
the application's top-level setup and execution logic, which falls under the purview of
the project's entrypoint script. As such, Dockerfile modifications will generally only
be necessary when updating non-Python environment dependencies (Python dependency
updates are automatically reflected in new image builds via the `pyproject.toml`
and `poetry.lock` files).
:white_check_mark: Testing
--------------------------
We use [`tox`](https://tox.readthedocs.io/en/latest/)
and [`pytest`](https://pytest.readthedocs.io/) for our test automation and testing
frameworks, respectively.
To invoke the tests, run:
```shell script
make test
```
Run [mutation tests](https://opensource.com/article/20/7/mutmut-python) to validate test
suite robustness (Optional):
```shell script
make test-mutations
```
> :information_source: **Technical Details**
> Test time scales with the complexity of the codebase. Results are cached
> in `.mutmut-cache`, so once you get past the initial [cold start problem](https://en.wikipedia.org/wiki/Cold_start_(recommender_systems)),
> subsequent mutation test runs will be much faster; new mutations will only
> be applied to modified code paths.
:rotating_light: Code Quality
-----------------------------
We use [`pre-commit`](https://pre-commit.com/) for our static analysis automation and
management framework.
To invoke the analyses and auto-formatting over all version-controlled files, run:
```shell script
make lint
```
> :rotating_light: **Danger**
> CI will fail if either testing or code quality fail,
> so it is recommended to automatically run the above locally
> prior to every commit that is pushed.
### :arrows_counterclockwise: Automate via Git Pre-Commit Hooks
To automatically run code quality validation on every commit (over to-be-committed
files), run:
```shell script
make install-pre-commit-hooks
```
> :warning:️ Warning
> This will prevent commits if any single pre-commit hook fails
> (unless it is allowed to fail)
> or a file is modified by an auto-formatting job;
> in the latter case, you may simply repeat the commit and it should pass.
:memo: Documentation
--------------------
```shell script
make docs-clean docs-html
```
> :fire: **Tip**
> For faster feedback loops, this will attempt to automatically open the newly
> built documentation static HTML in your browser.
:judge: Legal
=============
:page_facing_up: License
------------------------
cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance is licensed under the Apache License, Version 2.0.
See [LICENSE](./LICENSE) for the full license text.
:busts_in_silhouette: Credits
-----------------------------
This project was generated from
[`@TeoZosa`'s](https://github.com/TeoZosa)
[`cookiecutter-cruft-poetry-tox-pre-commit-ci-cd`](https://github.com/TeoZosa/cookiecutter-cruft-poetry-tox-pre-commit-ci-cd)
template.
نیازمندی
| مقدار | نام |
|---|---|
| >=5.0.0,<6.0.0 | importlib-metadata |
| >=1.0.0,<2.0.0 | jupyter |
| >=3.6.2,<4.0.0 | matplotlib |
| >=0.21.0,<0.22.0 | python-dotenv |
| >=12.5.1,<13.0.0 | rich |
| >=1.11.0,<2.0.0 | sentry-sdk |
| >=0.18.0,<0.19.0 | structlog-sentry-logger |
| >=2.13.3,<3.0.0 | typeguard |
| >=0.4,<0.7 | typer[all] |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.8,<3.12 | Python |
نحوه نصب
نصب پکیج whl cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance-0.0.3:
pip install cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance-0.0.3.whl
نصب پکیج tar.gz cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance-0.0.3:
pip install cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance-0.0.3.tar.gz