Skip to content

Commit fc9155c

Browse files
Diapolo10Diapolo10
authored
Merge pull request #1 from Diapolo10/nightly
[MINOR] 0.1.0 release
2 parents 2c4538b + 56dd2ea commit fc9155c

File tree

20 files changed

+1108
-1
lines changed

20 files changed

+1108
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## Describe the bug
11+
12+
A clear and concise description of what the bug is.
13+
14+
## To Reproduce
15+
16+
Steps to reproduce the behavior:
17+
18+
1. Go to '...'
19+
2. Click on '....'
20+
3. Scroll down to '....'
21+
4. See error
22+
23+
## Expected behavior
24+
25+
A clear and concise description of what you expected to happen.
26+
27+
## Screenshots
28+
29+
If applicable, add screenshots to help explain your problem.
30+
31+
## Desktop (please complete the following information)
32+
33+
- OS: [e.g. iOS]
34+
- Browser [e.g. chrome, safari]
35+
- Version [e.g. 22]
36+
37+
## Smartphone (please complete the following information)
38+
39+
- Device: [e.g. iPhone6]
40+
- OS: [e.g. iOS8.1]
41+
- Browser [e.g. stock browser, safari]
42+
- Version [e.g. 22]
43+
44+
## Additional context
45+
46+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/custom.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Custom issue template
3+
about: Describe this issue template's purpose here.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## Is your feature request related to a problem? Please describe it
11+
12+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13+
14+
## Describe the solution you'd like
15+
16+
A clear and concise description of what you want to happen.
17+
18+
## Describe alternatives you've considered
19+
20+
A clear and concise description of any alternative solutions or features you've considered.
21+
22+
## Additional context
23+
24+
Add any other context or screenshots about the feature request here.

‎.github/workflows/flake8.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# This workflow runs the Flake8 linter on git push
2+
3+
name: Flake8
4+
5+
on: [ push ]
6+
7+
jobs:
8+
flake8:
9+
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v2.3.4
14+
15+
- name: Set up Python 3.9
16+
uses: actions/setup-python@v2.2.2
17+
with:
18+
python-version: 3.9
19+
20+
- name: Install Poetry
21+
uses: Gr1N/setup-poetry@v4
22+
23+
- name: Install library and dependencies
24+
run: |
25+
poetry run pip install --upgrade pip setuptools
26+
poetry install
27+
28+
- name: Lint with flake8
29+
run: |
30+
# Stop the build if there are Python syntax errors or undefined names
31+
poetry run pflake8 --count --select=E9,F63,F7,F82 --show-source --statistics
32+
# exit-zero treats all errors as warnings
33+
poetry run pflake8 --count --exit-zero --statistics

‎.github/workflows/pylint.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# This workflow runs the Pylint linter on git push
2+
3+
name: Pylint
4+
5+
on: [ push ]
6+
7+
jobs:
8+
pylint:
9+
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v2.3.4
14+
15+
- name: Set up Python 3.9
16+
uses: actions/setup-python@v2.2.2
17+
with:
18+
python-version: 3.9
19+
20+
- name: Install Poetry
21+
uses: Gr1N/setup-poetry@v4
22+
23+
- name: Install library and dependencies
24+
run: |
25+
poetry run pip install --upgrade pip setuptools
26+
poetry install
27+
28+
- name: Analysing the code with pylint
29+
run: |
30+
poetry run pylint escapyde

‎.github/workflows/pypi_deploy.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# This workflow deploys a new release on PyPI once a pull request is closed
2+
3+
name: Deploy to PyPI
4+
5+
on:
6+
pull_request:
7+
types: [ closed ]
8+
branches:
9+
- main
10+
11+
jobs:
12+
pypi-deploy:
13+
name: Build and publish Python 🐍 distributions 📦 to live PyPI
14+
runs-on: ubuntu-latest
15+
if: github.event.pull_request.merged == true
16+
17+
steps:
18+
- uses: actions/checkout@master
19+
20+
- name: Publish distribution 📦 to PyPI
21+
uses: JRubics/poetry-publish@v1.7
22+
with:
23+
ignore_dev_requirements: 'yes'
24+
pypi_token: ${{ secrets.PYPI_PASSWORD }}

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,3 +112,6 @@ dmypy.json
112112

113113
# Pyre type checker
114114
.pyre/
115+
116+
# DeepCode/Snyk
117+
.dccache

‎CHANGELOG.md‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
2+
# IPlib3 Change Log
3+
4+
All notable changes to this project will be documented in this file.
5+
6+
The format is based on [CHANGELOG.md](http://changelog.md/)
7+
and this project adheres to [Semantic Versioning](http://semver.org/).
8+
9+
<!--
10+
TEMPLATE
11+
12+
## [major.minor.patch] - yyyy-mm-dd
13+
14+
A message that notes the main changes in the update.
15+
16+
### Added
17+
18+
### Changed
19+
20+
### Deprecated
21+
22+
### Fixed
23+
24+
### Removed
25+
26+
### Security
27+
28+
_______________________________________________________________________________
29+
30+
-->
31+
32+
<!--
33+
EXAMPLE
34+
35+
## [0.2.0] - 2021-06-02
36+
37+
Lorem Ipsum dolor sit amet.
38+
39+
### Added
40+
41+
- Cat pictures hidden in the library
42+
- Added beeswax to the gears
43+
44+
### Changed
45+
46+
- Updated localisation files
47+
48+
-->
49+
50+
<!--
51+
_______________________________________________________________________________
52+
53+
## [0.2.3] - YYYY-MM-DD
54+
55+
First official documentation.
56+
57+
### Added
58+
59+
- Documentation
60+
- Now using specific versions for the dependencies
61+
62+
### Changed
63+
64+
- Changed the filename of `deploy.yml` to `pypi_deploy.yml` to get rid of a YAML validator complaint
65+
- Updated dependencies
66+
67+
-->
68+
69+
_______________________________________________________________________________
70+
71+
## [0.1.0] - 2021-05-01
72+
73+
This is the beginning of the changelog. Previously made commits have not been
74+
tracked, and there are no plans to distinguish them. You may consider this
75+
the initial commit.
76+
77+
### Added
78+
79+
- Added Poetry files and build system
80+
- Added a Lorem Ipsum example text snippet
81+
- Added GitHub Actions
82+
- Added autonatic PyPI releases
83+
- Added 'clear' as a built-in formatting option
84+
- Added a `Makefile`
85+
- Added docstrings thorought the package
86+
87+
### Changed
88+
89+
- The releases are now built on the latest version of Ubuntu, using Python 3.9
90+
- `README.md` now has more content, including example usage
91+
- Default colours are now available from the top level of the package
92+
(eg. `escapyde.FRED` instead of `escapyde.colours.FRED`)
93+
- Updated the localisation files
94+
95+
### Fixed
96+
97+
- Fixed an oversight related to chaining ANSI escape sequences
98+
- Fixed linter issues
99+
100+
<!-- markdownlint-configure-file {
101+
"MD022": false,
102+
"MD024": false,
103+
"MD030": false,
104+
"MD032": false
105+
} -->
106+
<!--
107+
MD022: Blanks around headings
108+
MD024: No duplicate headings
109+
MD030: Spaces after list markers
110+
MD032: Blanks around lists
111+
-->

0 commit comments

Comments
 (0)