معرفی شرکت ها
calcipy-0.9.1
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Python package to simplify development. Includes functionality for task running, testing, linting, documenting, and more
| ویژگی | مقدار |
|---|---|
| سیستم عامل | OS Independent |
| نام فایل | calcipy-0.9.1 |
| نام | calcipy |
| نسخه کتابخانه | 0.9.1 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Kyle King |
| ایمیل نویسنده | dev.act.kyle@gmail.com |
| آدرس صفحه اصلی | https://github.com/kyleking/calcipy |
| آدرس اینترنتی | https://pypi.org/project/calcipy/ |
| مجوز | MIT |
# calcipy
`calcipy` is a Python package that implements best practices such as code style (linting, auto-fixes), documentation, CI/CD, and logging. Like the calcium carbonate in hard coral, packages can be built on the `calcipy` foundation.
`calcipy` has some configurability, but is tailored for my particular use cases. If you want the same sort of functionality, there are a number of alternatives to consider:
- [pyscaffold](https://github.com/pyscaffold/pyscaffold) is a much more mature project that aims for the same goals, but with a slightly different approach and tech stack (tox vs. nox, cookiecutter vs. copier, etc.)
- [tidypy](https://github.com/jayclassless/tidypy#features), [pylama](https://github.com/klen/pylama), and [codecheck](https://pypi.org/project/codecheck/) offer similar functionality of bundling and running static checkers, but makes far fewer assumptions
- [pytoil](https://github.com/FollowTheProcess/pytoil) is a general CLI tool for developer automation
- And many more such as [pyta](https://github.com/pyta-uoft/pyta), [prospector](https://github.com/PyCQA/prospector), [wemake-python-styleguide](https://github.com/wemake-services/wemake-python-styleguide) / [cjolowicz/cookiecutter-hypermodern-python](https://github.com/cjolowicz/cookiecutter-hypermodern-python), etc.
## Installation
Calcipy needs a few static files managed using copier and a template project: [kyleking/calcipy_template](https://github.com/KyleKing/calcipy_template/)
You can quickly use the template to create a new project or add calcipy to an existing one:
```sh
# Install copier. Pipx is recommended
pipx install copier
# To create a new project
copier copy gh:KyleKing/calcipy_template new_project
cd new_project
# Or update an existing one
cd my_project
copier copy gh:KyleKing/calcipy_template .
```
See [./Advanced_Configuration.md](./Advanced_Configuration.md) for documentation on the configurable aspects of `calcipy`
### Calcipy CLI
Additionally, `calcipy` can be run as a CLI application without adding the package as a dependency.
Quick Start:
```sh
pipx install calcipy
# Use the Collect Code Tags command to write all code tags to a single file
calcipy collect-code-tags -h
calcipy collect-code-tags -b=~/Some/Project
# See additional documentation from the CLI help
calcipy -h
```
### Calcipy Pre-Commit
`calcipy` can also be used as a `pre-commit` task by adding the below snippet to your `pre-commit` file:
```yaml
repos:
- repo: https://github.com/KyleKing/calcipy
rev: main
hooks:
- id: calcipy-code-tags
```
## Calcipy Module Features
The core functionality of calcipy is the rich set of tasks run with `doit`
- `poetry run doit --continue`: runs all default tasks. On CI (AppVeyor), this is a shorter list that should PASS, while locally the list is longer that are much more strict for linting and quality analysis
- The local default tasks include:
- **collect_code_tags**: Create a summary file with all of the found code tags. (i.e. TODO/FIXME, default output is [./docs/CODE_TAG_SUMMARY.md](./docs/CODE_TAG_SUMMARY.md))
- **cl_write**: Auto-generate the changelog based on commit history and tags.
- **lock**: Ensure poetry.lock and requirements.txt are up-to-date.
- **nox_coverage**: Run the coverage session in nox.
- **auto_format**: Format code with isort, autopep8, and others.
- **document**: Build the HTML documentation. (along with creating code diagrams!)
- **check_for_stale_packages**: Check for stale packages.
- **pre_commit_hooks**: Run the pre-commit hooks on all files.
- **lint_project**: Lint all project files that can be checked. (py, yaml, json, etc.)
- **static_checks**: General static checkers (Inspection Tiger, etc.).
- **security_checks**: Use linting tools to identify possible security vulnerabilities.
- **check_types**: Run type annotation checks.
- Additional tasks include:
- **nox**/**test**/**coverage**: Tasks for running nox sessions, pytest in the local environment, and pytest coverage
- **ptw\_\***: Variations of tasks to run pytest watch
- **cl_bump** (**cl_bump_pre**):Bumps project version based on commits & settings in pyproject.toml.
- **deploy_docs**: Deploy docs to the Github `gh-pages` branch.
- **publish**: Build the distributable format(s) and publish.
- **check_license**: Check licenses for compatibility.
- **lint_critical_only**: Suppress non-critical linting errors. Great for gating PRs/commits.
- **lint_python**: Lint all Python files and create summary of errors.
- **open_docs**: Open the documentation files in the default browser.
- **open_test_docs**: Open the test and coverage files in default browser.
- **zip_release**: Zip up important information in the releases directory.
- **calcipy** also provides a few additional nice features
- **dev.conftest**: some additional pytest configuration logic that outputs better HTML reports. Automatically implemented (imported to `tests/conftest.py`) when using `calcipy_template`
- **dev.noxfile**: nox functions that can be imported and run with or without the associated doit tasks. Also automatically configured when using `calcipy_template`
- **file_helpers**: some nice utilities for working with files, such as `sanitize_filename`, `tail_lines`, `delete_old_files`, etc. See documentation for most up-to-date documentation
- **log_heleprs**: where the most common use will be for `activate_debug_logging` or the more customizable `build_logger_config`
- **dot_dict**: has one function `ddict`, which is a light-weight wrapper around whatever is the most [maintained dotted-dictionary package in Python](https://pypi.org/search/?q=dot+accessible+dictionary&o=). Dotted dictionaries can sometimes improve code readability, but they aren't a one-size fits all solution. Sometimes `attr.s` or `dataclass` are more appropriate.
- The benefit of this wrapper is that there is a stable interface and you don't need to rewrite code as packages are born and die (i.e. [Bunch](https://pypi.org/project/bunch/) > [Chunk](https://pypi.org/project/chunk/) > [Munch](https://pypi.org/project/munch/) > [flexible-dotdict](https://pypi.org/project/flexible-dotdict/) > [Python-Box](https://pypi.org/project/python-box/) > ...)
- Note: if you need nested dotted dictionaries, check out [classy-json](https://pypi.org/project/classy-json/)
> NOTE
>
> For the full list of available tasks, run `poetry run doit list`
## Project Status
See the `Open Issues` and/or the [CODE_TAG_SUMMARY]. For release history, see the [CHANGELOG].
## Contributing
We welcome pull requests! For your pull request to be accepted smoothly, we suggest that you first open a GitHub issue to discuss your idea. For resources on getting started with the code base, see the below documentation:
- [DEVELOPER_GUIDE]
- [STYLE_GUIDE]
- [CONTRIBUTING]
## Code of Conduct
We follow the [Contributor Covenant Code of Conduct][contributor-covenant].
## Responsible Disclosure
If you have any security issue to report, please contact the project maintainers privately. You can reach us at [dev.act.kyle@gmail.com](mailto:dev.act.kyle@gmail.com).
## License
[LICENSE]
[changelog]: ./docs/CHANGELOG.md
[code_tag_summary]: ./docs/CODE_TAG_SUMMARY.md
[contributing]: ./docs/CONTRIBUTING.md
[contributor-covenant]: https://www.contributor-covenant.org
[developer_guide]: ./docs/DEVELOPER_GUIDE.md
[license]: https://github.com/kyleking/calcipy/LICENSE
[style_guide]: ./docs/STYLE_GUIDE.md
نیازمندی
| مقدار | نام |
|---|---|
| >=1.2.3 | arrow |
| >=0.10.4 | beartype |
| >=0.22.0 | bidict |
| >=3.0.6 | cement |
| >=5.1.1 | decorator |
| >=0.6.0 | loguru |
| >=1.3.5 | pandas |
| >=1.10.2 | pydantic |
| >=6.0.2 | python-box |
| >=0.8.10 | tabulate |
| >=0.34.2 | doit |
| >=2.20.0 | pre-commit |
| >=2.4 | pyrate_limiter |
| >=1.0.4 | sty |
| >=2.0.1 | tomli |
| >=0.8.11 | transitions |
| >=5.2 | pyyaml |
| >=2.28.1 | requests |
| >=1.23.1) | numpy |
| >=0.3.3) | better-exceptions |
| >=2.28.0) | commitizen |
| >=1.2) | mdx_truly_sane_lists |
| >=1.7.4) | mkdocs-build-plantuml-plugin |
| >=0.4.0) | mkdocs-gen-files |
| >=1.0.1) | mkdocs-git-revision-date-localized-plugin |
| >=3.3.0) | mkdocs-include-markdown-plugin |
| >=0.5.0) | mkdocs-literate-nav |
| >=8.2.16) | mkdocs-material |
| >=0.3.4) | mkdocs-section-index |
| >=0.18.1) | mkdocstrings[python] |
| >=2.32.1) | pyupgrade |
| >=0.3.1) | absolufy-imports |
| >=2.2.3) | add-trailing-comma |
| >=1.4) | autoflake |
| >=1.5.5) | autopep8 |
| >=1.0.0) | cohesion |
| >=1.8.1) | darglint |
| >=0.12.0) | dlint |
| >=1.5.0) | docformatter |
| >=5.0.4) | flake8 |
| >=1.6.1) | flake8-2020 |
| >=0.12.2) | flake8-aaa |
| >=2.9.0) | flake8-annotations |
| >=2.1.0) | flake8-assertive |
| >=3.0.0) | flake8-bandit |
| >=0.2.1) | flake8-blind-except |
| >=1.1.0) | flake8-breakpoint |
| >=0.4.0) | flake8-broken-line |
| >=22.4.25) | flake8-bugbear |
| >=1.5.3) | flake8-builtins |
| >=0.1.0) | flake8-cognitive-complexity |
| >=3.10.0) | flake8-comprehensions |
| >=4.1.2) | flake8-debugger |
| >=1.6.0) | flake8-docstrings |
| >=1.2.1) | flake8-eradicate |
| >=0.0.11) | flake8-expression-complexity |
| >=1.0.3) | flake8-fine-pytest |
| >=1.1.1) | flake8-fixme |
| >=0.0.7) | flake8-functions |
| >=4.1.1) | flake8-isort |
| >=0.6.0) | flake8-logging-format |
| >=0.3.0) | flake8-markdown |
| >=1.3.0) | flake8-pep3101 |
| >=0.16.0) | flake8-pie |
| >=0.2.post0) | flake8-plone-hasattr |
| >=5.0.0) | flake8-print |
| >=1.1.2) | flake8-printf-formatting |
| >=1.6.0) | flake8-pytest-style |
| >=3.3.1) | flake8-quotes |
| >=1.1.3) | flake8-return |
| >=0.19.0) | flake8-simplify |
| >=0.4.1) | flake8-SQL |
| >=0.3.0) | flake8-string-format |
| >=0.4.1) | flake8-tuple |
| >=1.13.0) | flake8-typing-imports |
| >=0.0.5) | flake8-variables-names |
| >=5.10.1) | isort |
| >=2022) | licensecheck[full] |
| >=4.8.0) | lxml |
| >=0.981) | mypy |
| >=0.2.3) | pandas-vet |
| >=0.11.1) | pep8-naming |
| >=2.7) | pip-check |
| >=0.13.0) | proselint |
| >=2.13.9) | pylint |
| >=0.114.0) | semgrep |
| >=1.1.0) | tryceratops |
| >=5.1.8.1) | types-decorator |
| >=6.0.12) | types-pyyaml |
| >=2.28.11.2) | types-requests |
| >=0.11.3) | unimport |
| >=2.4) | vulture |
| >=0.9.0) | xenon |
| >=1.26.3) | yamllint |
| >=6.5.0) | diff-cover |
| >=1.0.0) | nox-poetry |
| >=7.1.2) | pytest |
| >=3.0.0) | pytest-cov |
| >=3.1.1) | pytest-html |
| >=0.2.3) | pytest-watcher |
| >=0.1.2) | cz_legacy |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.8.4,<4.0.0 | Python |
نحوه نصب
نصب پکیج whl calcipy-0.9.1:
pip install calcipy-0.9.1.whl
نصب پکیج tar.gz calcipy-0.9.1:
pip install calcipy-0.9.1.tar.gz