Project configuration as code
Project description
synth-a-py
Project configuration as code
Example usage
#!/usr/bin/env python
from textwrap import dedent
from synth_a_py import Dir, Project, SimpleFile, TomlFile
project_name = "sample-project"
project_version = "0.1.0"
project_import = project_name.lower().replace("-", "_")
spec = Project()
with spec:
with Dir(".github"):
with Dir("workflows"):
SimpleFile(
"ci.yml",
dedent(
"""\
...
"""
),
)
SimpleFile(
"publish.yml",
dedent(
"""\
...
"""
),
)
TomlFile(
"pyproject.toml",
{
"build-system": {
"requires": ["poetry>=0.12"],
"build-backend": "poetry.masonry.api",
},
"tool": {
"poetry": {
"name": project_name,
"version": project_version,
"description": "A sample project generated using synth-a-py",
"authors": ["Joseph Egan"],
"dependencies": {
"python": "^3.6",
},
"dev-dependencies": {
"pytest": "^6",
"pyprojroot": "^0.2.0",
},
},
},
},
)
SimpleFile(
"Makefile",
dedent(
"""\
.PHONEY: test
test:
\tpoetry install
\tpoetry run pytest
"""
),
)
with Dir(project_import):
SimpleFile(
"__init__.py",
dedent(
f"""\
__version__ = "{project_version}"
"""
),
)
with Dir("tests"):
SimpleFile(
"test_version.py",
dedent(
f"""\
import toml
from pyprojroot import here
from {project_import} import __version__
def test_version() -> None:
pyproject = toml.load(here("pyproject.toml"))
pyproject_version = pyproject["tool"]["poetry"]["version"]
assert __version__ == pyproject_version
"""
),
)
spec.synth()
Goals
- Use synth-a-py to manage project configs
- Add support for:
- LICENSE
- TOML (for pyproject.toml)
- YAML (for GitHub Actions config)
- GitHub Action workflow?
- INI (for flake8/mypy config)
- Makefile
- .gitignore
- Add ./synth.py
- Add support for:
- Templates:
- Poetry
- setup.py
- Pipenv
- In-repo examples:
- Minimal
- Monorepo
Updating project config
To do this make edits to the .projenrc.js
file in the root of the project and run npx projen
to update existing or generate new config. Please also use npx prettier --trailing-comma all --write .projenrc.js
to format this file.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
synth-a-py-1.3.0.tar.gz
(10.2 kB
view hashes)
Built Distribution
synth_a_py-1.3.0-py3-none-any.whl
(10.2 kB
view hashes)
Close
Hashes for synth_a_py-1.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 47b3d9b90936a505e857ea6162268df0b59cc9e7e119a69cdd53c5b2ea3addc0 |
|
MD5 | ef9b46c8383e9a3a5e76f24fed559ca5 |
|
BLAKE2b-256 | d847b58e7e4b03765c9f967e87680c7db02028e961437cda7bde0ea5814155cc |