Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
Update README to markdown
  • Loading branch information
cperrin88 authored Jan 3, 2017
1 parent 7998e17 commit 2baec2c
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 22 deletions.
2 changes: 1 addition & 1 deletion .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ test_python2:
upload:
stage: upload
script:
- pip install twine wheel babel
- pip install twine wheel babel pypandoc
- python3 setup.py compile_catalog -d pammysqltools/locales
- python3 setup.py sdist bdist_wheel
- twine upload -u "$PYPI_USERNAME" -p "$PYPI_PASSWORD" dist/*
Expand Down
9 changes: 8 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,20 @@ python:
- '3.5-dev'
- 'nightly'

sudo: false

cache: pip

services: mysql

addons:
apt:
packages:
- pandoc

install:
- pip install --upgrade coveralls coverage pypandoc
- pip install --upgrade .
- pip install --upgrade coveralls coverage

before_script: mysql -e 'CREATE DATABASE IF NOT EXISTS auth_test;'

Expand Down
30 changes: 16 additions & 14 deletions README.rst → README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,41 @@
PAMMySQL Tools
==============

.. image:: https://travis-ci.org/cperrin88/PAMMySQLTools.svg?branch=master
:target: https://travis-ci.org/cperrin88/PAMMySQLTools
.. image:: https://coveralls.io/repos/github/cperrin88/PAMMySQLTools/badge.svg?branch=master
:target: https://coveralls.io/github/cperrin88/PAMMySQLTools?branch=master
[![build](https://travis-ci.org/cperrin88/PAMMySQLTools.svg?branch=master)](https://travis-ci.org/cperrin88/PAMMySQLTools) [![coverage](https://coveralls.io/repos/github/cperrin88/PAMMySQLTools/badge.svg?branch=master)](https://coveralls.io/github/cperrin88/PAMMySQLTools?branch=master)

PAMMySQL Tools ist a suite to manage users for pam_mysql and libnss-mysql. It tries to mimic the behaviours of the linux tools user{add,mod,del} and group{add,mod,del}
PAMMySQL Tools ist a suite to manage users for pam\_mysql and
libnss-mysql. It tries to mimic the behaviours of the linux tools
user{add,mod,del} and group{add,mod,del}

Installation
------------

To install simply run::
To install simply run:

pip install PAMMySQLTools

This will install the scripts:
- myuseradd
- myusermod
- myuserdel
- mygroupadd
- mygroupmod
- mygroupdel

- myuseradd
- myusermod
- myuserdel
- mygroupadd
- mygroupmod
- mygroupdel

Configuration
-------------

In the directory :code:`docs` you can find an example config with all everything set. If you don't set a value, the tools will assume the values in the original config as default values.
In the directory `docs` you can find an example config with
all everything set. If you don't set a value, the tools will assume the
values in the original config as default values.

Running the Software
--------------------

To display help for any of the scripts, start with the --help parameter

For example::
For example:

$ myuseradd --help
Usage: myuseradd [OPTIONS] LOGIN
Expand Down
13 changes: 7 additions & 6 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
from setuptools import setup, find_packages


def readme():
with open('README.rst') as f:
return f.read()
try:
from pypandoc import convert
read_md = lambda f: convert(f, 'rst')
except ImportError:
read_md = lambda f: open(f, 'r').read()


setup(name='PAMMySQLTools',
Expand All @@ -15,9 +16,9 @@ def readme():
url='https://github.com/cperrin88/PAMMySQLTools',
license='MIT',
packages=find_packages(),
long_description=readme(),
long_description=read_md('README.md'),
test_suite='tests',
setup_requires=['setuptools-git-version', 'babel'],
setup_requires=['setuptools-git-version', 'babel', 'pypandoc'],
install_requires=['pymysql', 'click', 'future', 'six', 'configparser>=3.5.0b2'],
entry_points={
'console_scripts': [
Expand Down

0 comments on commit 2baec2c

Please sign in to comment.