aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorAdam Janovsky2021-04-24 12:44:51 +0200
committerAdam Janovsky2021-04-24 12:44:51 +0200
commitcb02c5a6b48cd9b71a0f5a23925bcb8f6b036d66 (patch)
tree2ea6f64cd7472ffd1bc1bec94cf3e9fa5ccc9618
parent56ac88fbe875f1518cab5d1d607eb1b5e2f38013 (diff)
downloadsec-certs-cb02c5a6b48cd9b71a0f5a23925bcb8f6b036d66.tar.gz
sec-certs-cb02c5a6b48cd9b71a0f5a23925bcb8f6b036d66.tar.zst
sec-certs-cb02c5a6b48cd9b71a0f5a23925bcb8f6b036d66.zip
add badges, workflow dispatch on publish
-rw-r--r--.github/workflows/python-publish.yml40
-rw-r--r--README.md24
2 files changed, 37 insertions, 27 deletions
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
index 22f85fe2..2fab292d 100644
--- a/.github/workflows/python-publish.yml
+++ b/.github/workflows/python-publish.yml
@@ -3,31 +3,31 @@
name: Upload Python Package
-on:
+on:
push:
- branches: [ master ]
+ branches: [master]
pull_request:
- branches: [ master ]
+ branches: [master]
+ workflow_dispatch:
jobs:
deploy:
-
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v2
- - name: Set up Python
- uses: actions/setup-python@v2
- with:
- python-version: '3.8'
- - name: Install dependencies
- run: |
- python -m pip install --upgrade pip
- pip install setuptools wheel twine
- - name: Build and publish
- env:
- TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }} #Same as Docker, need to add an account in the secrets
- TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
- run: |
- python setup.py sdist bdist_wheel
- twine upload dist/*
+ - uses: actions/checkout@v2
+ - name: Set up Python
+ uses: actions/setup-python@v2
+ with:
+ python-version: "3.8"
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install setuptools wheel twine
+ - name: Build and publish
+ env:
+ TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }} #Same as Docker, need to add an account in the secrets
+ TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+ run: |
+ python setup.py sdist bdist_wheel
+ twine upload dist/*
diff --git a/README.md b/README.md
index 144d7bb6..340f1329 100644
--- a/README.md
+++ b/README.md
@@ -4,19 +4,29 @@ Tool for analysis of security certificates and their security targets (Common Cr
This project is developed by the [Centre for Research On Cryptography and Security](https://crocs.fi.muni.cz) at Faculty of Informatics, Masaryk University.
-![Website](https://img.shields.io/website?down_color=red&down_message=offline&style=flat-square&up_color=SpringGreen&up_message=online&url=https%3A%2F%2Fseccerts.org)
+[![Website](https://img.shields.io/website?down_color=red&down_message=offline&style=flat-square&up_color=SpringGreen&up_message=online&url=https%3A%2F%2Fseccerts.org)](https://seccerts.org)
+[![PyPI](https://img.shields.io/pypi/v/sec-certs?style=flat-square)](https://pypi.org/project/sec-certs/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sec-certs?label=Python%20versions&style=flat-square)](https://pypi.org/project/sec-certs/)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/crocs-muni/sec-certs/tests?style=flat-square)](https://github.com/crocs-muni/sec-certs/actions/workflows/GA_CI.yml)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/crocs-muni/sec-certs/Docker%20Image%20CI?label=Docker%20build&style=flat-square)](https://hub.docker.com/repository/docker/seccerts/sec-certs)
-![PyPI](https://img.shields.io/pypi/v/sec-certs?style=flat-square)
+## Installation (CC)
-![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sec-certs?label=Python%20versions&style=flat-square)
+The tool requires several Python packages as well as the `pdftotext` binary somewhere on the `PATH`.
+[
+The stable release is published on [PyPi](https://pypi.org/project/sec-certs/) as well as on [DockerHub](https://hub.docker.com/repository/docker/seccerts/sec-certs), you can install it with:
-![GitHub Workflow Status](https://img.shields.io/github/workflow/status/crocs-muni/sec-certs/tests?style=flat-square)
+```
+pip install -U sec-certs
+```
+or
-## Installation (CC)
+```
+docker pull seccerts/sec-certs
+```
-The tool requires several Python packages as well as the `pdftotext` binary somewhere on the `PATH`.
-The easiest way to setup the tool is to install it in a virtual environment, e.g.:
+Alternatively, you can setup the tool for development in a virtual environment, e.g.:
Install Python virtual environment (if not yet):
```
python3 -m pip install --upgrade pip