Skip to content

Commit

Permalink
adding pypi badge; using public action for pypi (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidslusser authored Jul 23, 2023
1 parent b143e5d commit 8ced800
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 31 deletions.
29 changes: 7 additions & 22 deletions .github/workflows/pypi.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# This workflows will upload a Python Package using Twine when a release is created
# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries

name: Upload Python Package

on:
Expand All @@ -16,24 +13,12 @@ on:
- '[0-9]+.[0-9]+.[0-9]+'

jobs:
deploy:

pypi:
runs-on: ubuntu-latest

name: "pypi"
steps:
- uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install build setuptools setuptools_scm wheel twine
- name: Build and publish
env:
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
run: |
python -m build
twine upload dist/*
- uses: davidslusser/actions_python_pypi@test
with:
build_command: "python setup.py sdist bdist_wheel"
pypi_username: ${{ secrets.PYPI_USERNAME }}
pypi_password: ${{ secrets.PYPI_PASSWORD }}
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# django-hostutils
[![Downloads](https://static.pepy.tech/badge/django-hostutils)](https://pepy.tech/project/django-hostutils)
[![PyPI](https://img.shields.io/pypi/v/django-hostutils?label=pypi%20package&color=blue)](https://pypi.org/project/django-hostutils/)
[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7474/badge)](https://bestpractices.coreinfrastructure.org/projects/7474)

![PyPI - Python](https://img.shields.io/pypi/pyversions/django-hostutils)
Expand All @@ -22,7 +23,7 @@ Django hostutils is a collection of utilities to provide information and metrics
|Bandit|security checks|![Bandit](https://github.com/djangoaddicts/django-hostutils/actions/workflows/bandit.yaml/badge.svg)|
|Black|code formatting|![Black](https://github.com/djangoaddicts/django-hostutils/actions/workflows/black.yaml/badge.svg)|
|CodeQL|security analysis|[![CodeQL](https://github.com/djangoaddicts/django-hostutils/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/djangoaddicts/django-hostutils/actions/workflows/github-code-scanning/codeql)|
|Coveralls|code coverage status|[![Coverage Status](https://coveralls.io/repos/github/djangoaddicts/django-hostutils/badge.svg?branch=coveralls)](https://coveralls.io/github/djangoaddicts/django-hostutils?branch=coveralls)|
|Coveralls|code coverage status|![Coverage Status](https://github.com/djangoaddicts/django-hostutils/actions/workflows/coveralls.yaml/badge.svg)|
|Isort|python import ordering|![Isort](https://github.com/djangoaddicts/django-hostutils/actions/workflows/isort.yaml/badge.svg)|
|Mypy|static type checking|![Mypy](https://github.com/djangoaddicts/django-hostutils/actions/workflows/mypy.yaml/badge.svg)|
|Pytest|unit testing|![Pytest](https://github.com/djangoaddicts/django-hostutils/actions/workflows/pytest.yaml/badge.svg)|
Expand All @@ -31,23 +32,21 @@ Django hostutils is a collection of utilities to provide information and metrics
|Safety|dependency scanner|![Saftey](https://github.com/djangoaddicts/django-hostutils/actions/workflows/safety.yaml/badge.svg)|


<br/>
### Code Coverage:
[![Coverage Status](https://coveralls.io/repos/github/djangoaddicts/django-hostutils/badge.svg?branch=coveralls)](https://coveralls.io/github/djangoaddicts/django-hostutils?branch=coveralls)

### Code Coverage Dashboard:
https://coveralls.io/github/djangoaddicts/django-hostutils
Dashboard: https://coveralls.io/github/djangoaddicts/django-hostutils


<br/>

## Documentation
| Workflow | Description | Status |
|----------|-------------------------|------------------------------------------------------------------------------|
|Docs|ReadTheDocs Build|[![Documentation Status](https://readthedocs.org/projects/django-hostutils/badge/?version=latest)](https://django-hostutils.readthedocs.io/en/latest/?badge=latest)|

Full documentation is available here:
[![Documentation Status](https://readthedocs.org/projects/django-hostutils/badge/?version=latest)](https://django-hostutils.readthedocs.io/en/latest/?badge=latest)

https://django-hostutils.readthedocs.io/en/latest/index.html
Full documentation can be found on: https://django-hostutils.readthedocs.io/en/latest/index.html

Documentation source files are available in the [docs](https://github.com/djangoaddicts/django-hostutils/tree/main/docs/source) folder.

<br/>

Expand Down

0 comments on commit 8ced800

Please sign in to comment.