GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-25 04:02:45 +01:00
Code Issues Projects Releases Wiki Activity

Merge branch 'devel' into wip/irc-explosion

Browse Source
This commit is contained in:
James Lu 2017-06-15 21:13:49 -07:00
commit 8dae235b8d
3 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.travis.yml
View File

@ -1,3 +1,6 @@
dist: trusty
sudo: false
language: python
python:
- '3.4'
@ -27,7 +30,5 @@ deploy:
condition: $(python3 -c 'import re,os; print(bool(re.match(r"^(\d+\.){2,}\d+$", os.environ.get("TRAVIS_TAG", ""))))') == "True"
python: '3.6'
skip_upload_docs: true
notifications:
email: false

18
README.md
View File

@ -55,15 +55,23 @@ You can also find support via our IRC channels: `#PyLink @ irc.overdrivenetworks
3) Download or copy https://github.com/GLolol/PyLink/blob/master/example-conf.yml for an example configuration.
### Installing via Debian APT repository (stable branch only)
### Installing via Debian APT repository (8/Jessie+ and above)
[The Utopia Repository](https://packages.overdrivenetworks.com/) hosts `.deb` packages for PyLink. For Debian Jessie (stable) and Stretch/sid (testing), the `pylink` package and its dependencies are available in the `main` section. See https://packages.overdrivenetworks.com/#instructions for setup instructions.
[The Utopia Repository](https://packages.overdrivenetworks.com/) hosts unofficial Debian packages for PyLink, which are available for Jessie and Stretch/unstable. Two versions of the `pylink` package are available:
Upon installing `pylink`, example configurations and docs will be in `/usr/share/doc/pylink/examples` and `/usr/share/doc/pylink/docs` respectively. You can also install a local copy of the [PyLink API reference](https://pylink.github.io/), which is provided by the `pylink-doc` package.
- The latest stable release and its dependencies are available in the `main` section of the corresponding Debian version (e.g. [`jessie/main`)](https://packages.overdrivenetworks.com/jessie_list.html).
- Nightly builds of the PyLink `devel` branch are available in the corresponding `nightlies` section (e.g. [`jessie-nightlies/main`](https://packages.overdrivenetworks.com/jessie-nightlies_list.html))
### Installing via Ubuntu PPA (stable branch only)
See https://packages.overdrivenetworks.com/ for setup instructions.
Ubuntu packages for PyLink are available from the [PyLink PPA](https://launchpad.net/~tacocat/+archive/ubuntu/pylink) for Ubuntu 14.04 LTS (trusty) and above. Like with the Debian installation, example configurations and docs will be in `/usr/share/doc/pylink/examples` and `/usr/share/doc/pylink/docs` respectively.
Upon installing `pylink`, example configuration and docs will be in `/usr/share/doc/pylink/examples` and `/usr/share/doc/pylink/docs` respectively. You can also install a local copy of the [PyLink API reference](https://pylink.github.io/) through the `pylink-doc` package.
### Installing via Ubuntu PPA (14.04/Trusty and above)
Unofficial Ubuntu packages for PyLink are available via two PPAs for Ubuntu 14.04 LTS (trusty) and above. Like with the Debian installation, example configuration and docs will be in `/usr/share/doc/pylink/examples` and `/usr/share/doc/pylink/docs` respectively.
- Stable releases: [PyLink Stable PPA](https://launchpad.net/~tacocat/+archive/ubuntu/pylink)
- Nightly builds (devel branch): [PyLink Nightly Builds PPA](https://launchpad.net/~tacocat/+archive/ubuntu/pylink-nightly)
## Configuration

6
setup.py
View File

@ -12,10 +12,10 @@ except ImportError:
from codecs import open
import subprocess
# Get version from Git tags.
with open('VERSION', encoding='utf-8') as f:
version = f.read().strip()
# Try to fetch the current commit hash from Git.
try:
real_version = subprocess.check_output(['git', 'describe', '--tags']).decode('utf-8').strip()
except Exception as e:
@ -32,7 +32,7 @@ with open('__init__.py', 'w') as f:
# Convert Markdown to RST for PyPI
try:
import pypandoc
long_description = pypandoc.convert('README.md', 'rst')
long_description = pypandoc.convert('README.md', 'rst', format='markdown_github')
except ImportError:
print('WARNING: PyPandoc not available; skipping writing long description.')
long_description = None
@ -48,7 +48,7 @@ setup(
# Author details
author='James Lu',
author_email='GLolol@overdrivenetworks.com',
author_email='james@overdrivenetworks.com',
# Choose your license
license='MPL 2.0',