Skip to content

Commit

Permalink
update to latest standards
Browse files Browse the repository at this point in the history
  • Loading branch information
c0fec0de committed Oct 27, 2023
1 parent 1848d9b commit d2b8ad0
Show file tree
Hide file tree
Showing 21 changed files with 727 additions and 1,086 deletions.
54 changes: 54 additions & 0 deletions .github/workflows/main.yml
@@ -0,0 +1,54 @@
name: test

on: [push, pull_request, release]

jobs:
build:

strategy:
matrix:
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
sudo apt-get install -y graphviz
pip install tox "poetry>=1.4" coveralls
- name: TOX
run: tox
- name: Upload coverage data to coveralls.io
run: coveralls --service=github
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
COVERALLS_FLAG_NAME: ${{ matrix.test-name }}
COVERALLS_PARALLEL: true

coveralls:
name: Indicate completion to coveralls.io
needs: build
runs-on: ubuntu-latest
container: python:3-slim
steps:
- name: Finished
run: |
pip3 install --upgrade coveralls
coveralls --service=github --finish
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

publish:
if: github.event_name == 'push' && github.ref_type == 'tag'
needs: coveralls
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Build and publish to pypi
uses: JRubics/poetry-publish@v1.17
with:
pypi_token: ${{ secrets.PYPI_TOKEN }}
15 changes: 9 additions & 6 deletions .gitignore
@@ -1,10 +1,13 @@
*.egg-info/
*.eggs/
*.pyc
*.sublime-workspace
*.xml
.coverage
.tox/
.tox
.venv
.mypy_cache
/.vscode
__pycache__
coverage-report/
build
dist/
docs/build/
docs/_readthedocs/
poetry.lock
setup.py
18 changes: 18 additions & 0 deletions .readthedocs.yaml
@@ -0,0 +1,18 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.9"

commands:
- pip install --upgrade --no-cache-dir pip
- pip install --no-cache-dir "poetry>=1.4" "crashtest==0.4.1"
- poetry install --with=doc --without=test
- poetry run make html -C docs
- cp -r docs/build _readthedocs
21 changes: 0 additions & 21 deletions .travis.yml

This file was deleted.

56 changes: 41 additions & 15 deletions README.rst
@@ -1,41 +1,67 @@
.. image:: https://badge.fury.io/py/anycache.svg
:target: https://badge.fury.io/py/anycache

.. image:: https://travis-ci.org/c0fec0de/anycache.svg?branch=master
:target: https://travis-ci.org/c0fec0de/anycache
.. image:: https://img.shields.io/pypi/dm/anycache.svg?label=pypi%20downloads
:target: https://pypi.python.org/pypi/anycache

.. image:: https://readthedocs.org/projects/anycache/badge/?version=latest
:target: https://anycache.readthedocs.io/en/latest/?badge=latest

.. image:: https://coveralls.io/repos/github/c0fec0de/anycache/badge.svg
:target: https://coveralls.io/github/c0fec0de/anycache

.. image:: https://readthedocs.org/projects/anycache/badge/?version=2.0.7
:target: http://anycache.readthedocs.io/en/2.0.7/?badge=2.0.7
:target: https://anycache.readthedocs.io/en/2.0.7/?badge=2.0.7

.. image:: https://codeclimate.com/github/c0fec0de/anycache.png
:target: https://codeclimate.com/github/c0fec0de/anycache
.. image:: https://api.codeclimate.com/v1/badges/e6d325d6fd23a93aab20/maintainability
:target: https://codeclimate.com/github/c0fec0de/anycache/maintainability
:alt: Maintainability

.. image:: https://img.shields.io/pypi/pyversions/anycache.svg
:target: https://pypi.python.org/pypi/anycache

.. image:: https://landscape.io/github/c0fec0de/anycache/master/landscape.svg?style=flat
:target: https://landscape.io/github/c0fec0de/anycache/master

.. image:: https://img.shields.io/badge/code%20style-pep8-brightgreen.svg
:target: https://www.python.org/dev/peps/pep-0008/

.. image:: https://img.shields.io/badge/code%20style-pep257-brightgreen.svg
:target: https://www.python.org/dev/peps/pep-0257/

Cache any python object to file using improved pickling
.. image:: https://img.shields.io/badge/linter-pylint-%231674b1?style=flat
:target: https://www.pylint.org/

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black

.. image:: https://img.shields.io/github/contributors/c0fec0de/anycache.svg
:target: https://github.com/c0fec0de/anycache/graphs/contributors/

.. image:: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
:target: http://makeapullrequest.com

.. image:: https://img.shields.io/github/issues-pr/c0fec0de/anycache.svg
:target: https://github.com/c0fec0de/anycache/pulls

.. image:: https://img.shields.io/github/issues-pr-closed/c0fec0de/anycache.svg
:target: https://github.com/c0fec0de/anycache/pulls?q=is%3Apr+is%3Aclosed

Documentation
=============

The Documentation_ is hosted on http://anycache.readthedocs.io/en/2.0.7/
Links
=====

.. _Documentation: http://anycache.readthedocs.io/en/2.0.7/
* Documentation_
* PyPI_
* GitHub_
* Changelog_
* Issues_
* Contributors_

Getting started
===============
.. _anycache: https://anycache.readthedocs.io/en/2.0.7/
.. _Documentation: https://anycache.readthedocs.io/en/2.0.7/
.. _PyPI: https://pypi.org/project/anycache/2.0.7/
.. _GitHub: https://github.com/c0fec0de/anycache
.. _Changelog: https://github.com/c0fec0de/anycache/releases
.. _Issues: https://github.com/c0fec0de/anycache/issues
.. _Contributors: https://github.com/c0fec0de/anycache/graphs/contributors

.. _getting_started:

Expand Down
28 changes: 0 additions & 28 deletions anycache.sublime-project

This file was deleted.

0 comments on commit d2b8ad0

Please sign in to comment.