Skip to content

Commit c56942d

Browse files
andrea-mucciandrea-mucci
authored
Merge pull request #25 from Clariteia/0.0.1
0.0.1
2 parents 6eda31e + 3a403ff commit c56942d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+2471
-219
lines changed

‎.gitattributes‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Auto detect text files and perform LF normalization
2+
* text=auto

‎.github/workflows/python-docs.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# This workflow will upload a Python Package using Twine when a release is created
2+
# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
3+
4+
name: Publish Python Package Documentation
5+
6+
on:
7+
release:
8+
types: [ created ]
9+
10+
jobs:
11+
deploy:
12+
runs-on: ubuntu-latest
13+
container: python:3.9-buster
14+
15+
steps:
16+
- name: Check out repository code
17+
uses: actions/checkout@v2
18+
19+
- name: Install Poetry
20+
uses: snok/[email protected]
21+
22+
- name: Install dependencies
23+
run: make install
24+
25+
- name: Generate documentation
26+
run: make docs
27+
28+
- name: Deploy documentation
29+
uses: peaceiris/actions-gh-pages@v3
30+
with:
31+
github_token: ${{ secrets.GITHUB_TOKEN }}
32+
publish_dir: docs/_build/html

‎.github/workflows/python-publish.yml‎

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,27 @@
44
name: Upload Python Package
55

66
on:
7-
release:
8-
types: [created]
7+
release:
8+
types: [ created ]
99

1010
jobs:
11-
deploy:
12-
runs-on: ubuntu-latest
13-
steps:
14-
- uses: actions/checkout@v2
15-
- name: Set up Python
16-
uses: actions/setup-python@v2
17-
with:
18-
python-version: '3.x'
19-
- name: Install dependencies
20-
run: |
21-
python -m pip install --upgrade pip
22-
pip install setuptools wheel twine
23-
- name: Build and publish
24-
env:
25-
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
26-
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
27-
run: |
28-
python setup.py sdist bdist_wheel
29-
twine upload dist/*
11+
deploy:
12+
runs-on: ubuntu-latest
13+
container: python:3.9-buster
14+
15+
steps:
16+
17+
- name: Check out repository code
18+
uses: actions/checkout@v2
19+
20+
- name: Install Poetry
21+
uses: snok/[email protected]
22+
23+
- name: Install dependencies
24+
run: make install
25+
26+
- name: Publish package
27+
run: make release
28+
env:
29+
POETRY_HTTP_BASIC_PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
30+
POETRY_HTTP_BASIC_PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}

‎.github/workflows/python-tests.yml‎

Lines changed: 33 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,35 @@
1-
on:
2-
push:
3-
branches: [ main ]
4-
pull_request:
5-
branches: [ main ]
1+
on: push
62

73
jobs:
8-
build:
9-
runs-on: ubuntu-latest
10-
strategy:
11-
matrix:
12-
python-version: [3.9]
13-
14-
steps:
15-
- uses: actions/checkout@v2
16-
- name: Set up Python ${{ matrix.python-version }}
17-
uses: actions/setup-python@v2
18-
with:
19-
python-version: ${{ matrix.python-version }}
20-
- name: Install dependencies
21-
run: |
22-
python -m pip install --upgrade pip
23-
if [ -f requirements_dev.txt ]; then pip install -r requirements_dev.txt; fi
24-
python setup.py install
25-
- name: Test with pytest
26-
run: |
27-
make test
28-
- name: Generate coverage report
29-
run: |
30-
make coverage
31-
- name: Codecov
32-
uses: codecov/[email protected]
33-
with:
34-
token: ${{ secrets.CODECOV_TOKEN }}
35-
files: ./coverage.xml
36-
fail_ci_if_error: true
4+
build:
5+
runs-on: ubuntu-latest
6+
container: python:3.9-buster
7+
8+
steps:
9+
- name: Check out repository code
10+
uses: actions/checkout@v2
11+
12+
- name: Install Poetry
13+
uses: snok/[email protected]
14+
15+
- name: Install dependencies
16+
run: make install
17+
18+
- name: Lint package
19+
run: make lint
20+
21+
- name: Test package with coverage
22+
run: make coverage
23+
24+
- name: Publish coverage
25+
uses: codecov/[email protected]
26+
with:
27+
token: ${{ secrets.CODECOV_TOKEN }}
28+
files: ./coverage.xml
29+
fail_ci_if_error: true
30+
31+
- name: Generate documentation
32+
run: make docs
33+
34+
- name: Generate build
35+
run: make dist

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,4 +111,5 @@ ENV/
111111
*.mdb
112112

113113
# Sphinx Api Documentation
114-
docs/api
114+
115+
/docs/api

‎.pre-commit-config.yaml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
default_stages: [ commit ]
2+
repos:
3+
- repo: local
4+
hooks:
5+
- id: install
6+
pass_filenames: false
7+
name: Install dependencies
8+
entry: make install
9+
language: system
10+
11+
- id: reformat
12+
pass_filenames: false
13+
name: Reformat package
14+
entry: make reformat
15+
language: system
16+
17+
- id: lint
18+
pass_filenames: false
19+
name: Lint package
20+
entry: make lint
21+
language: system
22+
23+
- id: test
24+
pass_filenames: false
25+
name: Test package
26+
entry: make test
27+
language: system
28+
29+
- id: docs
30+
pass_filenames: false
31+
name: Generate documentation
32+
entry: make docs
33+
language: system
34+
35+
- id: build
36+
pass_filenames: false
37+
entry: make dist
38+
name: Generate build
39+
language: system

‎.restyled.yaml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
enabled: true
3+
exclude:
4+
- "**/*.md"
5+
- ".idea/**/*"
6+
- "docs/**/*"
7+
- "**/*.in"
8+
- "Makefile"
9+
- ".github/workflows/**/*"
10+
restylers:
11+
- name: black
12+
image: restyled/restyler-black:v19.10b0
13+
command:
14+
- black
15+
arguments: ["--line-length", "120"]
16+
include:
17+
- "**/*.py"
18+
interpreters:
19+
- python
20+
- name: isort
21+
image: restyled/restyler-isort:v5.8.0
22+
command:
23+
- isort
24+
arguments: []
25+
include:
26+
- "**/*.py"
27+
interpreters:
28+
- python

‎AUTHORS.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
Credits
2-
=======
1+
# Credits
32

4-
Development Lead
5-
----------------
3+
## Development Lead
64

75
* Andrea Mucci <[email protected]>
86

9-
Contributors
10-
------------
7+
## Core Devs
118

129
* Sergio Garcia Prado <[email protected]>
1310
* Vladyslav Fenchak <[email protected]>
11+
* Alberto Amigo Alonso <[email protected]>
12+
13+
## Contributors
14+
15+
None yet. Why not be the first?

‎CONTRIBUTING.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# How to contribute
2+
3+
Minos being an open-source project, we are looking forward to having your contributions. No matter whether it is a pull
4+
request with new features, or the creation of an issue related to a bug you have found.
5+
6+
Please consider these guidelines before you submit any modification.
7+
8+
Create an issue
9+
----------------
10+
1. If you happen to find a bug, please file a new issue filling the 'Bug report' template.
11+
2. Set the appropriate labels, so we can categorise it easily.
12+
3. Wait for any core developer's feedback on it.
13+
14+
Submit a Pull Request
15+
-----------------------
16+
1. Create an issue following the previous steps.
17+
2. Fork the project.
18+
3. Push your changes to a local branch.
19+
4. Run the tests!
20+
5. Submit a pull request from your fork's branch.

‎HISTORY.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
History
2-
=======
1+
# History
32

4-
0.0.1 (2021-05-13)
5-
------------------
3+
## 0.0.1 (2021-06-14)
64

75
* First release on PyPI.

0 commit comments

Comments
 (0)