Skip to content

Commit

Permalink
Use pyproject.toml purely (#6)
Browse files Browse the repository at this point in the history
* Relax Python requirement to 3

* Remove unsupported --three when calling pipenv

* Ignore OS and additional Python artifacts

* Remove setup.cfg (move them into pyproject.toml)

* Use src layout for packages

* pyproject toml remove find package settings

* Drop pipenv

* Drop support for Py3.6 and 3.7

* Ensure package layout passes its tests

* Drop CLI template

* Fix all warnings

* Drop old versions in GitHub CI config, windows support, and test with bootstrapper

* Drop colour support in bootstrapper
  • Loading branch information
ginolatorilla committed Aug 13, 2023
1 parent 1202504 commit dd02b9b
Show file tree
Hide file tree
Showing 18 changed files with 366 additions and 734 deletions.
3 changes: 3 additions & 0 deletions .flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
exclude = .venv
max-line-length = 119
49 changes: 7 additions & 42 deletions .github/workflows/python.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,55 +8,20 @@ on:
branches:
- main

env:
PIPENV_VENV_IN_PROJECT: 1

jobs:
style-check:
name: Lint on Python ${{matrix.python-version}} @${{matrix.os-image}}
runs-on: ${{matrix.os-image}}
bootstrap-test:
name: Bootstrap on Python ${{matrix.python-version}} @${{matrix.os-image}}
strategy:
matrix:
os-image: ["ubuntu-latest", "windows-latest", "macos-latest"]
python-version: ["3.7", "3.8", "3.9", "3.10"]
include:
- os-image: ubuntu-latest
python-version: "3.6"
steps:
- uses: actions/checkout@v1
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: ${{matrix.python-version}}
- name: Install PipEnv
run: pip install pipenv
- name: Install development packages with PipEnv
run: python3 ./bootstrap.py --dev
- name: Lint with flake8 and mypy
run: |
pipenv run flake8
pipenv run mypy .
test:
name: Test on Python ${{matrix.python-version}} @${{matrix.os-image}}
os-image: ["ubuntu-latest", "macos-latest"]
python-version: ["3.8", "3.9", "3.10", "3.11"]
bootstrap-args: ["--layout=module", "--layout=package", "--dev"]
runs-on: ${{matrix.os-image}}
strategy:
matrix:
os-image: ["ubuntu-latest", "windows-latest", "macos-latest"]
python-version: ["3.7", "3.8", "3.9", "3.10"]
include:
- os-image: ubuntu-latest
python-version: "3.6"
steps:
- uses: actions/checkout@v1
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: ${{matrix.python-version}}
- name: Install PipEnv
run: pip install pipenv
- name: Install development packages with PipEnv
run: python3 ./bootstrap.py --dev
- name: Test with pytest
run: |
pipenv run pytest
- name: Run bootstrapper
run: python3 ./bootstrap.py ${{matrix.bootstrap-args}} -d .test
234 changes: 229 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,231 @@
.venv
**/__pycache__
*.egg-info
reqlib-metadata
.coverage
/setup.cfg
/pyproject.toml


# General
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon


# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

*~

# temporary files which can be created if a process still has a handle open of a deleted file
.fuse_hidden*

# KDE directory preferences
.directory

# Linux trash folder which might appear on any partition or disk
.Trash-*

# .nfs files are created when an open file is removed but is still being accessed
.nfs*

# Windows thumbnail cache files
Thumbs.db
Thumbs.db:encryptable
ehthumbs.db
ehthumbs_vista.db

# Dump file
*.stackdump

# Folder config file
[Dd]esktop.ini

# Recycle Bin used on file shares
$RECYCLE.BIN/

# Windows Installer files
*.cab
*.msi
*.msix
*.msm
*.msp

# Windows shortcuts
*.lnk

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
19 changes: 0 additions & 19 deletions Pipfile

This file was deleted.

Loading

0 comments on commit dd02b9b

Please sign in to comment.