Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eganjs/synth-a-py
Project configuration as code in Python
https://github.com/eganjs/synth-a-py
configuration-as-code poetry python3
Last synced: 20 days ago
JSON representation
Project configuration as code in Python
- Host: GitHub
- URL: https://github.com/eganjs/synth-a-py
- Owner: eganjs
- License: mit
- Created: 2020-10-26T23:34:16.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-05-11T20:34:08.000Z (over 3 years ago)
- Last Synced: 2024-12-10T14:12:43.465Z (27 days ago)
- Topics: configuration-as-code, poetry, python3
- Language: Python
- Homepage:
- Size: 93.8 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# synth-a-py
Project configuration as code
## Goals
- [ ] Use synth-a-py to manage project configs
- Add support for:
- [x] LICENSE
- [x] TOML (for pyproject.toml)
- [x] YAML (for GitHub Actions config)
- [ ] GitHub Action workflow?
- [x] INI (for flake8/mypy config)
- [ ] Makefile
- [x] .gitignore
- Add ./synth.py
- Templates:
- [ ] Poetry
- [ ] setup.py
- [ ] Pipenv
- In-repo examples:
- [ ] Minimal
- [ ] Monorepo
## Example usage
```python
#!/usr/bin/env python
from textwrap import dedent
from synth_a_py import Dir, License, Project, SimpleFile, TomlFile, YamlFile
authors = ["Joseph Egan"]
project_name = "sample-project"
project_description = "A sample project generated using synth-a-py"
project_version = "0.1.0"
project_import = project_name.lower().replace("-", "_")
spec = Project()
with spec:
TomlFile(
"pyproject.toml",
{
"build-system": {
"requires": ["poetry>=0.12"],
"build-backend": "poetry.masonry.api",
},
"tool": {
"poetry": {
"name": project_name,
"version": project_version,
"description": project_description,
"authors": authors,
"license": "MIT",
"dependencies": {
"python": "^3.6",
},
"dev-dependencies": {
"pytest": "^6",
"pyprojroot": "^0.2.0",
"synth-a-py": "../synth-a-py",
},
},
},
},
)
License.MIT("2020", ", ".join(authors))
GitIgnore(
ignore=[
"*.egg",
"*.egg-info/",
"*.pyc",
".cache/",
".idea/",
".mypy_cache/",
".venv/",
"dist/",
],
)
SimpleFile(
"Makefile",
dedent(
"""\
.PHONEY: test
test:
\tpoetry install
\tpoetry run pytest
.PHONEY: synth
synth:
\tpoetry run ./synth.py
"""
),
)
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
"""
),
)
with Dir(".github"):
with Dir("workflows"):
YamlFile(
"ci.yml",
{
"name": "ci",
"on": {
"pull_request": {
"branches": ["main"],
},
"push": {"branches": ["main"]},
},
"jobs": {
"test": {
"runs-on": "ubuntu-latest",
"steps": [
{
"name": "checkout",
"uses": "actions/checkout@v2",
},
{
"name": "setup Python",
"uses": "actions/setup-python@v2",
"with": {
"python-version": "3.9",
},
},
{
"name": "test",
"run": dedent(
"""\
pip install poetry
make test
"""
),
},
],
},
},
},
)
spec.synth()
```
## 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.