Skip to content

Commit 162dc98

Browse files
Valerii MaslenykovValeriyMaslenikov
Valerii Maslenykov
authored and
ValeriyMaslenikov
committed
Initial commit – v0.1.0-alpha.1
0 parents  commit 162dc98

Some content is hidden

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

58 files changed

+2827
-0
lines changed

‎.editorconfig‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# see https://editorconfig.org/
2+
root = true
3+
4+
[*]
5+
# Use Unix-style newlines for most files (except Windows files, see below).
6+
end_of_line = lf
7+
trim_trailing_whitespace = true
8+
indent_style = space
9+
insert_final_newline = true
10+
indent_size = 4
11+
charset = utf-8
12+
13+
[*.{bat,cmd,ps1}]
14+
end_of_line = crlf
15+
16+
[*.{yml,yaml}]
17+
indent_size = 2
18+
19+
[*.tsv]
20+
indent_style = tab

‎.github/workflows/on-publishing.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: "Publishing"
2+
on:
3+
release:
4+
types: [published]
5+
jobs:
6+
verification:
7+
uses: ./.github/workflows/verification.yml
8+
publish:
9+
runs-on: ubuntu-latest
10+
needs: verification
11+
steps:
12+
- uses: actions/checkout@v3
13+
with:
14+
fetch-depth: 0
15+
- uses: actions/setup-python@v4
16+
with:
17+
python-version: 3.11
18+
- name: Install dependencies
19+
run: |
20+
pip install --upgrade pip
21+
python -mpip install --progress-bar=off -r ci/requirements.txt
22+
virtualenv --version
23+
pip --version
24+
nox --version
25+
pip list --format=freeze
26+
- name: Publishing
27+
env:
28+
TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}
29+
TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
30+
run: |
31+
nox -e publish -v

‎.github/workflows/on-push.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
name: 'Code verification'
2+
on: [push, pull_request]
3+
jobs:
4+
verification:
5+
uses: ./.github/workflows/verification.yml
6+
7+

‎.github/workflows/verification.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Code Verification
2+
on: [workflow_call]
3+
jobs:
4+
lint:
5+
name: "Lint"
6+
runs-on: ubuntu-latest
7+
steps:
8+
- uses: actions/checkout@v3
9+
with:
10+
fetch-depth: 0
11+
- uses: actions/setup-python@v4
12+
with:
13+
python-version: 3.11
14+
- name: Install dependencies
15+
run: |
16+
pip install --upgrade pip
17+
python -mpip install --progress-bar=off -r ci/requirements.txt
18+
virtualenv --version
19+
pip --version
20+
nox --version
21+
pip list --format=freeze
22+
- name: Lint
23+
run: |
24+
nox -e lint -v
25+
test:
26+
name: ${{ matrix.os }}, ${{ matrix.python }}
27+
runs-on: ${{ matrix.os }}
28+
timeout-minutes: 30
29+
strategy:
30+
fail-fast: false
31+
matrix:
32+
os: [ubuntu-latest, windows-latest]
33+
python: ["3.7", "3.8", "3.9", "3.10", "3.11"]
34+
steps:
35+
- uses: actions/checkout@v3
36+
with:
37+
fetch-depth: 0
38+
- uses: actions/setup-python@v4
39+
with:
40+
python-version: ${{ matrix.python }}
41+
cache: pip
42+
- name: install dependencies
43+
run: |
44+
pip install --upgrade pip
45+
python -mpip install --progress-bar=off -r ci/requirements.txt
46+
virtualenv --version
47+
pip --version
48+
nox --version
49+
pip list --format=freeze
50+
- name: test
51+
run: |
52+
nox -p ${{ matrix.python }} -e test -v

‎.gitignore‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
*.py[cod]
2+
__pycache__
3+
4+
# C extensions
5+
*.so
6+
7+
# Packages
8+
*.egg
9+
*.egg-info
10+
dist
11+
build
12+
eggs
13+
.eggs
14+
parts
15+
bin
16+
var
17+
sdist
18+
wheelhouse
19+
develop-eggs
20+
.installed.cfg
21+
lib
22+
lib64
23+
venv*/
24+
pyvenv*/
25+
pip-wheel-metadata/
26+
27+
# Installer logs
28+
pip-log.txt
29+
30+
# Unit test / coverage reports
31+
.coverage
32+
.nox
33+
.coverage.*
34+
.pytest_cache/
35+
nosetests.xml
36+
coverage.xml
37+
htmlcov
38+
39+
# Translations
40+
*.mo
41+
42+
# Buildout
43+
.mr.developer.cfg
44+
45+
# IDE project files
46+
.project
47+
.pydevproject
48+
.idea
49+
.vscode
50+
*.iml
51+
*.komodoproject
52+
53+
# Complexity
54+
output/*.html
55+
output/*/index.html
56+
57+
# Sphinx
58+
docs/_build
59+
60+
.DS_Store
61+
*~
62+
.*.sw[po]
63+
.build
64+
.ve
65+
.env
66+
.cache
67+
.pytest
68+
.benchmarks
69+
.bootstrap
70+
.appveyor.token
71+
*.bak
72+
73+
# Mypy Cache
74+
.mypy_cache/

‎CHANGELOG.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [0.1.0-alpha.1]
9+
10+
### Added
11+
12+
- Source code with the implementation of `get_contents` and `get_content`
13+
- [Examples](./examples)
14+
- Documentation [(README.md)](./README.md)
15+
- [GitHub Actions pipeline](https://github.com/getjoystick/joystick-python/tree/main/.github/workflows) to check code style + Unit Testing at different Python versions + different platforms

‎LICENSE.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) Joystick letsgo@getjoystick.com
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
13+
all 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
21+
THE SOFTWARE.

‎MANIFEST.in‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
graft src
2+
graft ci
3+
graft tests
4+
5+
include .editorconfig
6+
include .github/workflows/github-actions.yml
7+
include nox.py
8+
9+
include CHANGELOG.md
10+
include LICENSE.md
11+
include README.md
12+
13+
global-exclude *.py[cod] __pycache__/* *.so *.dylib

0 commit comments

Comments
 (0)