Metadata-Version: 2.0
Name: miniauth
Version: 0.1.0
Summary: Simple local user authentication
Home-page: https://github.com/farzadghanei/miniauth
Author: Farzad Ghanei
Author-email: farzad.ghanei@gmail.com
License: MIT
Keywords: auth userdb
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Provides-Extra: dev
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: mock; extra == 'dev'
Requires-Dist: typing; extra == 'dev'
Requires-Dist: pycodestyle; extra == 'dev'

********
MiniAuth
********

MiniAuth is a small program (and a Python library) for user authentication,
providing an interface easy to integrate with other programs.

It's designed to be simple and portable.
MiniAuth is written in Python, supports Python versions 2.7 and Python 3.4+,
has no dependencies other than Python standard library.

.. code-block:: python

   >>> from miniauth.auth import MiniAuth
   >>> auth = MiniAuth('users.db')
   >>> auth.create_user('user', 'password')
   True
   >>> auth.verify_user('user', 'password')
   True
   >>> auth.verify_user('user', 'invalidpassword')
   False


When the package is installed, a CLI tool is provided to manage and use a local database of users,
using a SQLite backend.

.. code-block::

   $ miniauth save testuser
   Password:
   # miniauth.db is a SQLite DB created in pwd

   $ miniauth verify testuser
   Password:
   # exit codes report the result of verification

   $ miniauth --help
   usage: miniauth [-h] [-s STORAGE] [-q] [-v] [--version]
                   {save,remove,disable,enable,verify} ...

   manage a database of users

   positional arguments:
     {save,remove,disable,enable,verify}
                           available actions
       save                create or update a user
       remove              remove a user
       disable             disable an existing user
       enable              enable an existing user
       verify              verify user credentials

   optional arguments:
     -h, --help            show this help message and exit
     -s STORAGE, --storage STORAGE
                           the auth storage. default is miniauth.db
     -q, --quiet           run in quiet mode (overwrites verbose)
     -v, --verbose         run in verbose mode
     --version             show program's version number and exit



Installation
============

.. code-block:: bash

   $ pip install miniauth


Or installing from source:

.. code-block:: bash

   $ python setup.py install


Development
===========

Source code is on `GitHub <https://github.com/farzadghanei/miniauth>`_

In development/test environments `pytest <https://pypi.org/project/pytest/>`_, `mock <https://pypi.org/project/mock>`_
, `pycodestyle <https://pypi.org/project/pycodestyle/>`_ and `mypy <https://pypi.org/project/mypy/>`_ are required.


.. code-block:: bash

    # on dev/test env
    $ pip install -r requirements/dev.txt


Tests
-----

`Tox <https://pypi.org/project/tox/>`_ is most convenient to run tests with, since it handles virtualenvs

.. code-block:: bash

    $ tox

Or when development dependencies are installed (preferably with a virtual environment),
tests can be run by directly calling `pytest`.

.. code-block:: bash

    $ pytest


License
=======
MiniAuth is an open source project released under the terms of MIT license.

The MIT License (MIT)

Copyright (c) 2018-2019 Farzad Ghanei

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


