Skip to content

Commit 3579aa0

Browse files
vberliervberlier
committed
Initial commit
0 parents  commit 3579aa0

23 files changed

+3567
-0
lines changed

‎.github/dependabot.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
version: 2
2+
3+
updates:
4+
- package-ecosystem: "npm"
5+
directory: "/"
6+
schedule:
7+
interval: "daily"
8+
9+
- package-ecosystem: "pip"
10+
directory: "/"
11+
schedule:
12+
interval: "daily"

‎.github/workflows/main.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
main:
11+
name: Test and release
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- uses: actions/checkout@v2
16+
with:
17+
fetch-depth: 0
18+
- name: Set up Python 3.10
19+
uses: actions/setup-python@v2
20+
with:
21+
python-version: "3.10"
22+
- name: Install Poetry
23+
uses: snok/[email protected]
24+
with:
25+
virtualenvs-in-project: true
26+
- name: Install Pyright
27+
run: npm install
28+
- name: Setup cache
29+
id: cached-poetry-dependencies
30+
uses: actions/cache@v2
31+
with:
32+
path: .venv
33+
key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
34+
- name: Install dependencies
35+
if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
36+
run: poetry install
37+
- name: Run tests
38+
run: poetry run pytest -v
39+
- name: Run type-checking
40+
run: npm run check
41+
- name: Check formatting
42+
run: poetry run black --check FIXME examples tests
43+
- name: Release
44+
if: |
45+
github.repository == 'FIXME/FIXME'
46+
&& github.event_name == 'push'
47+
&& github.ref == 'refs/heads/main'
48+
env:
49+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
50+
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
51+
run: |
52+
git config --global user.name "github-actions"
53+
git config --global user.email "[email protected]"
54+
poetry run semantic-release publish -v DEBUG -D commit_author="github-actions <[email protected]>"

‎.gitignore

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
target/
76+
77+
# Jupyter Notebook
78+
.ipynb_checkpoints
79+
80+
# IPython
81+
profile_default/
82+
ipython_config.py
83+
84+
# pyenv
85+
.python-version
86+
87+
# pipenv
88+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
90+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
91+
# install all needed dependencies.
92+
#Pipfile.lock
93+
94+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
95+
__pypackages__/
96+
97+
# Celery stuff
98+
celerybeat-schedule
99+
celerybeat.pid
100+
101+
# SageMath parsed files
102+
*.sage.py
103+
104+
# Environments
105+
.env
106+
.venv
107+
env/
108+
venv/
109+
ENV/
110+
env.bak/
111+
venv.bak/
112+
113+
# Spyder project settings
114+
.spyderproject
115+
.spyproject
116+
117+
# Rope project settings
118+
.ropeproject
119+
120+
# mkdocs documentation
121+
/site
122+
123+
# mypy
124+
.mypy_cache/
125+
.dmypy.json
126+
dmypy.json
127+
128+
# Pyre type checker
129+
.pyre/
130+
131+
# Node
132+
node_modules/

‎.vscode/extensions.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"recommendations": [
3+
"ms-python.python",
4+
"ms-python.vscode-pylance",
5+
"bungcip.better-toml"
6+
]
7+
}

‎.vscode/settings.json

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"python.formatting.provider": "black",
3+
"python.languageServer": "Pylance",
4+
"python.linting.enabled": false,
5+
"python.linting.pylintEnabled": false,
6+
"python.linting.banditEnabled": false,
7+
"python.linting.flake8Enabled": false,
8+
"python.linting.mypyEnabled": false,
9+
"python.linting.prospectorEnabled": false,
10+
"python.linting.pycodestyleEnabled": false,
11+
"python.linting.pydocstyleEnabled": false,
12+
"python.linting.pylamaEnabled": false,
13+
"[python]": {
14+
"editor.tabSize": 4,
15+
"editor.formatOnSave": true,
16+
"editor.formatOnType": false,
17+
"editor.formatOnPaste": false,
18+
"editor.codeActionsOnSave": {
19+
"source.organizeImports": true
20+
}
21+
}
22+
}

‎CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Changelog
2+
3+
<!--next-version-placeholder-->

‎FIXME/__init__.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
__version__ = "0.0.0"
2+
3+
4+
from .plugin import *

‎FIXME/plugin.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
__all__ = [
2+
"beet_default",
3+
]
4+
5+
6+
from beet import Context, Function
7+
8+
9+
def beet_default(ctx: Context):
10+
ctx.generate(Function(["say hello"]))

‎FIXME/py.typed

Whitespace-only changes.

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 FIXME
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# FIXME
2+
3+
[![GitHub Actions](https://github.com/FIXME/FIXME/workflows/CI/badge.svg)](https://github.com/FIXME/FIXME/actions)
4+
[![PyPI](https://img.shields.io/pypi/v/FIXME.svg)](https://pypi.org/project/FIXME/)
5+
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/FIXME.svg)](https://pypi.org/project/FIXME/)
6+
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
7+
[![Discord](https://img.shields.io/discord/900530660677156924?color=7289DA&label=discord&logo=discord&logoColor=fff)](https://discord.gg/98MdSGMm8j)
8+
9+
> FIXME
10+
11+
## Introduction
12+
13+
FIXME
14+
15+
## Installation
16+
17+
The package can be installed with `pip`.
18+
19+
```bash
20+
$ pip install FIXME
21+
```
22+
23+
## Getting started
24+
25+
FIXME
26+
27+
## Contributing
28+
29+
Contributions are welcome. Make sure to first open an issue discussing the problem or the new feature before creating a pull request. The project uses [`poetry`](https://python-poetry.org).
30+
31+
```bash
32+
$ poetry install
33+
```
34+
35+
You can run the tests with `poetry run pytest`.
36+
37+
```bash
38+
$ poetry run pytest
39+
```
40+
41+
The project must type-check with [`pyright`](https://github.com/microsoft/pyright). If you're using VSCode the [`pylance`](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) extension should report diagnostics automatically. You can also install the type-checker locally with `npm install` and run it from the command-line.
42+
43+
```bash
44+
$ npm run watch
45+
$ npm run check
46+
```
47+
48+
The code follows the [`black`](https://github.com/psf/black) code style. Import statements are sorted with [`isort`](https://pycqa.github.io/isort/).
49+
50+
```bash
51+
$ poetry run isort FIXME examples tests
52+
$ poetry run black FIXME examples tests
53+
$ poetry run black --check FIXME examples tests
54+
```
55+
56+
---
57+
58+
License - [MIT](https://github.com/FIXME/FIXME/blob/main/LICENSE)

‎docs/changelog.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
hide-toc: true
3+
---
4+
5+
```{include} ../CHANGELOG.md
6+
7+
```

‎docs/index.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# FIXME
2+
3+
```{toctree}
4+
:hidden:
5+
6+
changelog
7+
```
8+
9+
```{toctree}
10+
:caption: Project links
11+
:hidden:
12+
13+
GitHub repository <https://github.com/FIXME/FIXME>
14+
PyPI package <https://pypi.org/project/FIXME>
15+
```
16+
17+
```{eval-rst}
18+
.. mdinclude:: ../README.md
19+
:start-line: 10
20+
:end-line: -3
21+
```

‎examples/basic/beet.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
pipeline:
2+
- FIXME

‎package-lock.json

Lines changed: 33 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)