معرفی شرکت ها
drytoml-0.2.8
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Keep toml configuration centralized and personalizable
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | drytoml-0.2.8 |
| نام | drytoml |
| نسخه کتابخانه | 0.2.8 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Pablo Woolvett |
| ایمیل نویسنده | pablowoolvett@gmail.com |
| آدرس صفحه اصلی | https://github.com/pwoolvett/drytoml |
| آدرس اینترنتی | https://pypi.org/project/drytoml/ |
| مجوز | Unlicense |
# drytoml
Keep your toml configuration centralized and personalizable.
---
[](https://pypi.org/project/drytoml/)
[](https://www.python.org/downloads/)
---
[](https://drytoml.readthedocs.io/en/latest/)
---
[](https://github.com/pwoolvett/drytoml/actions?query=workflow%3AFormat)
[](https://github.com/pwoolvett/drytoml/actions?query=workflow%3ALint)
[](https://github.com/pwoolvett/drytoml/actions?query=workflow%3ATest)
[](https://codecov.io/gh/pwoolvett/drytoml)
---
[](https://code.visualstudio.com/docs/remote/containers)
[](http://unlicense.org/)
---
Through `drytoml`, TOML files can have references to any content from another TOML file.
References work with relative/absolute paths and urls, and can point to whole files, a
specific table, or in general anything reachable by a sequence of `getitem` calls, like
`["tool", "poetry", "source", 0, "url"]`. `drytoml` takes care of transcluding the
content for you.
Inspired by [flakehell](https://pypi.org/project/flakehell/) and
[nitpick](https://pypi.org/project/nitpick/), the main motivation behind `drytoml` is to
have several projects sharing a common, centralized configuration defining codestyles,
but still allowing granular control when required.
This is a deliberate departure from [nitpick](https://pypi.org/project/nitpick/), which
works as a linter instead, ensuring your local files have the right content.
## Usage
`drytoml` has two main usages:
1. Use a file as a reference and "build" the resulting one:
```toml
# contents of pyproject.dry.toml
...
[tool.black]
__extends = "../../common/black.toml"
target-version = ['py37']
include = '\.pyi?$'
...
```
```toml
# contents of ../../common/black.toml
[tool.black]
line-length = 100
```
```console
$ dry export --file=pyproject.dry.toml > pyproject.toml
```
```toml
# contents of pyproject.toml
[tool.black]
line-length = 100
target-version = ['py37']
include = '\.pyi?$'
```
2. Use included wrappers, allowing you to use references in your current configuration
without changing any file:
Consider the original `pyproject.dry.toml` from the example above, an alternative
usage for `drytoml` is shown next. Instead of this:
```console
$ black .
All done! ✨ 🍰 ✨
14 files left unchanged.
```
You would run this:
```console
$ dry black
reformatted /path/to/cwd/file_with_potentially_long_lines.py
reformatted /path/to/cwd/another_file_with_potentially_long_lines.py
All done! ✨ 🍰 ✨
2 files reformatted, 12 files left unchanged.
```
What just happened? `drytoml` comes with a set of wrappers which
1. Create a transcluded temporary file, equivalent to the resulting `pyproject.toml`
in the example above
2. Configure the wrapped tool (`black` in this case) to use the temporary file
3. Run `black`, and get rid of the file on exit.
For the moment, the following wrappers are available (more to come, contributions are
welcome):
* [x] [black](https://github.com/psf/black)
* [x] [isort](https://pycqa.github.io/isort/)
* [x] [flakehell, flake8helled](https://github.com/life4/flakehell) *
In the works:
* [ ] docformatter
* [ ] pytest
### Notes
Although the flakehell project was archived, we're keeping a fork alive from
[here](https://github.com/pwoolvett/flakehell), availabe as
[flakeheaven](https://pypi.org/project/flakeheaven) in pypi.
## Setup
### Prerequisites
* A compatible python >3.6.9
* [recommended] virtualenv
* A recent `pip`
### Install
Install as usual, with `pip`, `poetry`, etc:
* `pip install drytoml`
* `poetry add drytoml` (probably you'll want `poetry add --dev drytoml` instead)
## Usage
For any command , run `--help` to find out flags and usage.
Some of the most common are listed below:
* Use any of the provided wrappers as a subcommand, eg `dry black` instead of `black`.
* Use `dry -q export` and redirect to a file, to generate a new file with transcluded
contents
* Use `dry cache` to manage the cache for remote references.
## FAQ
**Q: I want to use a different key to trigger transclusions**
A: In cli mode (using the `dry` command), you can pass the `--key` flagcli, to change
it. In api mode (from python code), initialize `drytoml.parser.Parser` using a
custom value for the `extend_key` kwarg.
**Q: I changed a referenced toml upstream (eg in github) but still get the same result.**
A: Run `dry cache clear --help` to see available options.
## Contribute
Start by creating an issue, forking the project and creating a Pull Request.
### Setting up the development environment
If you have docker, the easiest way is to use the provided devcontainer inside vscode,
which already contains everything pre-installed. You must open the cloned directory
using the [remote-containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
Just run `poetry shell` or prepend any command with `poetry run` to ensure commands
are run inside the virtual environment.
Alternatively, you can use poetry: `poetry install -E dev`
The next steps assume you have already activated the venv.
### Committing
* Commits in every branch must adhere to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
Releases are done automatically and require conventional commits messages compliance.
* To validate commits, you can install the pre-commit hook
```console
pre-commit install --hook-type commit-msg
```
* With venv activated, you can commit using `cz commit` instead of `git commit` to
ensure compliance.
### Running checks
You can look at the different actions defined in `.github/workflows`. There are three
ways to check your code:
* Remotely, by pushing to an open PR. You'll se the results in the PR page.
* Manually, executing the check from inside a venv
For example, to generate the documentation, check `.github/workflows/docs`. To run the
`Build with Sphinx` step:
```console
sphinx-build docs/src docs/build
```
Or to run pytest, from `.github/workflows/tests.yml`:
```console
sphinx-build docs/src docs/build
```
... etc
* Locally, with [act](https://github.com/nektos/act) (Already installed in the
devcontainer)
For example, to emulate a PR run for the tests workflow:
```console
act -W .github/workflows/tests.yml pull_request
```
## TODO
Check out current development [here](https://github.com/pwoolvett/drytoml/projects/2)
نیازمندی
| مقدار | نام |
|---|---|
| >=0.7.0,<0.8.0 | tomlkit |
| >=0.4.0,<0.5.0 | fire |
| >=20.8b1,<21.0) | black |
| >=0.10.0-alpha.0,<0.11.0) | flakeheaven |
| >=5.7.0,<6.0.0) | isort |
| >=6.2.2,<7.0.0) | pytest |
| >=3.4.3,<4.0.0) | Sphinx |
| >=2.11.1,<3.0.0) | pytest-cov |
| >=0.5.1,<0.6.0) | sphinx-rtd-theme |
| >=2.1.2,<3.0.0) | flake8-bandit |
| >=20.11.1,<21.0.0) | flake8-bugbear |
| >=1.5.3,<2.0.0) | flake8-builtins |
| >=3.3.1,<4.0.0) | flake8-comprehensions |
| >=1.6.0,<2.0.0) | darglint |
| >=1.5.0,<2.0.0) | flake8-docstrings |
| >=1.0.0,<2.0.0) | flake8-eradicate |
| >=1.2.0,<2.0.0) | flake8-mutable |
| >=4.0.0,<5.0.0) | flake8-debugger |
| >=1.3.0,<2.0.0) | flake8-pytest-style |
| >=0.11.1,<0.12.0) | pep8-naming |
| >=3.1.1,<4.0.0) | pytest-html |
| >=0.2.7,<0.3.0) | m2r2 |
| >=0.7.1,<0.8.0) | recommonmark |
| >=2.14.2,<3.0.0) | commitizen |
| >=2.10.1,<3.0.0) | pre-commit |
| >=2.6.0,<3.0.0) | pylint |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.6.9,<4.0.0 | Python |
نحوه نصب
نصب پکیج whl drytoml-0.2.8:
pip install drytoml-0.2.8.whl
نصب پکیج tar.gz drytoml-0.2.8:
pip install drytoml-0.2.8.tar.gz