Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added pypi on release workflow #3

Merged
merged 1 commit into from Jan 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
35 changes: 35 additions & 0 deletions .github/workflows/build.yml
@@ -0,0 +1,35 @@

name: publish

on:
release:
types:
- created
workflow_dispatch:


jobs:
publish:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Set up Python "3.8"
uses: actions/setup-python@v2
with:
python-version: "3.8"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
run: |
pip install .
- name: Build a binary wheel and a source tarball
run: |
pip install build
python -m build --sdist --wheel --outdir dist/ .
- name: Publish distribution 📦 to PyPI
uses: pypa/gh-action-pypi-publish@master
with:
password: ${{ secrets.PYPI_API_TOKEN }}
21 changes: 5 additions & 16 deletions README.md
@@ -1,5 +1,7 @@
# asciiMOL

[![PyPI version](https://badge.fury.io/py/asciimol.svg)](https://badge.fury.io/py/asciimol)

![Screenshots](docs/anim.gif)

A basic molecule viewer written in Python, using curses; Thus, meant for linux terminals.
Expand All @@ -20,19 +22,6 @@ On the horizon:

## Installation

You will need:
* git
* python3
* python3-setuptools (should be included in most python3 installations)
* python3-numpy

1. Clone the repository using\
`git clone https://github.com/dewberryants/asciiMol.git`

2. Navigate into the folder (containing the setup.py), then run:\
`pip install --user .`\
which will install the pacakage into your local python site package directory. You can choose to omit the `--user`
flag, however be aware that this might then require root privilege.

3. Use the module by typing:\
`python -m asciimol input.xyz`
```sh
pip install asciimol
```
9 changes: 8 additions & 1 deletion setup.py
Expand Up @@ -15,8 +15,15 @@
long_description=readme,
author='Dominik Behrens',
author_email='dewberryants@gmail.com',
install_requires=['numpy'],
url='https://github.com/dewberryants/asciimol',
license=lic,
packages=find_packages(exclude="docs"),
package_data={"": ["data/*"]}
package_data={"": ["data/*"]},
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: BSD 2 License",
"Operating System :: OS Independent",
"Topic :: Scientific/Engineering :: Chemistry"
],
)