Metadata-Version: 2.1
Name: little-pwny
Version: 0.2
Summary: Check whether your password has been pwnd
Home-page: https://github.com/ulif/little-pwny
Author: ulif
Author-email: uli@gnufix.de
License: GPL3
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: Utilities
Classifier: Topic :: Security :: Cryptography
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Description-Content-Type: text/x-rst
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'

little-pwny
***********

Check whether a password has been compromised

|bdg-build| \| |pypi-release|


Query the `have-i-been-pwned database <https://haveibeenpwned.com>`_ for breaches
that contain a given password. Returns the number of breaches found in the
database::

    $ pwny p@ssw0rd
    51763

    $ pwny aiPh1eehec8AhY2y
    0

Please note, that the executable script is called `pwny`.

At no time the raw password is transferred to https://haveibeenpwned.com.
Instead we use the generously offered haveibeenpwned.com-API to deploy
`k-anonymity <https://en.wikipedia.org/wiki/K-anonymity>`_. I.e. we send the
first five chars of the SHA1 hash of any given password. This way you can check
new passwords without revealing them to the server (or any listening party).

`little-pwny` requires no additional packages. It requires Python 3.x.


Install
=======

with `pip`
----------

Simply::

    $ pip install little-pwny


From Source
-----------

Clone the source::

     $ git clone https://github.com/ulif/little-pwny
     $ cd little-pwny

Create and activate a virtualenv::

     $ virtualenv env
     $ source ./env/bin/activate.sh

Then, from this directory, install the package::

     [venv] $ pip install -e .


Running Tests
=============

We use `tox` and `py.test` for testing. So,::

     $ pip install tox
     $ tox

should run all tests.

.. |bdg-build| image:: https://travis-ci.org/ulif/little-pwny.svg?branch=master
   :target: https://travis-ci.org/ulif/little-pwny
   :alt: Build Status

.. |pypi-release| image:: https://img.shields.io/pypi/v/little-pwny?color=006dad
   :target: https://pypi.python.org/pypi/little-pwny/
   :alt: Latest release



Changes
=======

0.2 (2019-12-12)
----------------

- Officially also support Python 3.5 and 3.7
- Add support for commandline option `--version`.
- Add support for commandline option `--help`.


0.1 (2019-10-31)
----------------

- Initial release.





