Skip to content

Commit

Permalink
adopt latest black-pack
Browse files Browse the repository at this point in the history
  • Loading branch information
relleums committed Feb 22, 2024
1 parent 894796e commit 501d6e0
Show file tree
Hide file tree
Showing 8 changed files with 87 additions and 20 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
runs-on: ubuntu-latest
environment:
name: pypi
url: https://pypi.org/project/airshower_template_generator_cherenkov-plenoscope/
url: https://pypi.org/project/airshower_template_generator_cherenkov-plenoscope
steps:
- uses: actions/checkout@v3
- name: Set up Python
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ jobs:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install pip --upgrade
python -m pip install pytest
python -m pip install -r requirements.txt
python -m pip install .
- name: Test with pytest
run: |
pytest .
pytest .
77 changes: 69 additions & 8 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ __pycache__/

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
Expand All @@ -21,9 +20,11 @@ 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
Expand All @@ -38,13 +39,17 @@ pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
Expand All @@ -53,6 +58,8 @@ coverage.xml
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
Expand All @@ -65,27 +72,61 @@ instance/
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# pyenv
.python-version
# IPython
profile_default/
ipython_config.py

# celery beat schedule file
# 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

# dotenv
# Environments
.env

# virtualenv
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
Expand All @@ -97,3 +138,23 @@ ENV/
# 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/
12 changes: 9 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
############################
Airshower-Template-Generator
############################
|TestStatus| |PyPiStatus| |BlackStyle|
|TestStatus| |PyPiStatus| |BlackStyle| |BlackPackStyle| |GPLv3LicenseBadge|

|FigImageOfShower|

Expand All @@ -18,10 +18,16 @@ This uses KIT's CORSIKA to simulate the Cherenkov-emission in airshowers.
.. |BlackStyle| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black

.. |BlackPackStyle| image:: https://img.shields.io/badge/pack%20style-black-000000.svg
:target: https://github.com/cherenkov-plenoscope/black_pack

.. |TestStatus| image:: https://github.com/cherenkov-plenoscope/airshower_template_generator/actions/workflows/test.yml/badge.svg?branch=main
:target: https://github.com/cherenkov-plenoscope/airshower_template_generator/actions/workflows/test.yml
:target: https://github.com/cherenkov-plenoscope/airshower_template_generator/actions/workflows/test.yml

.. |PyPiStatus| image:: https://img.shields.io/pypi/v/airshower_template_generator_cherenkov-plenoscope
:target: https://pypi.org/project/airshower_template_generator_cherenkov-plenoscope/
:target: https://pypi.org/project/airshower_template_generator_cherenkov-plenoscope

.. |FigImageOfShower| image:: https://github.com/cherenkov-plenoscope/airshower_template_generator/blob/main/readme/view.jpg?raw=True

.. |GPLv3LicenseBadge| image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg
:target: https://www.gnu.org/licenses/gpl-3.0
2 changes: 1 addition & 1 deletion airshower_template_generator/version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.3.5"
__version__ = "0.3.6"
3 changes: 0 additions & 3 deletions project.toml

This file was deleted.

3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["setuptools>=49.6.0"]
build-backend = "setuptools.build_meta"
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import os


with open("README.rst", "r") as f:
with open("README.rst", "r", encoding="utf-8") as f:
long_description = f.read()


Expand All @@ -19,7 +19,7 @@
description="Generate Cherenkov-light-templates of cosmic-ray airshowers.",
long_description=long_description,
long_description_content_type="text/x-rst",
url="https://github.com/cherenkov-plenoscope/airshower_template_generator.git",
url="https://github.com/cherenkov-plenoscope/airshower_template_generator",
author="Sebastian Achim Mueller",
author_email="sebastian-achim.mueller@mpi-hd.mpg.de",
packages=[
Expand Down

0 comments on commit 501d6e0

Please sign in to comment.