https://github.com/mentoldo/sqlauthandle

Python package to manage Secure Authentication to SQL DB
https://github.com/mentoldo/sqlauthandle

Last synced: 4 months ago
JSON representation

Python package to manage Secure Authentication to SQL DB

• Host: GitHub
• URL: https://github.com/mentoldo/sqlauthandle
• Owner: mentoldo
• License: mit
• Created: 2021-12-02T21:29:51.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-15T17:21:19.000Z (over 3 years ago)
• Last Synced: 2024-04-26T11:01:03.856Z (12 months ago)
• Language: Python
• Homepage:
• Size: 36.1 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - mentoldo/sqlauthandle - Python package to manage Secure Authentication to SQL DB (Python)

README

        
=======

sqlauthandle

=======

.. image:: https://img.shields.io/pypi/v/sqlauthandle.svg

        :target: https://pypi.python.org/pypi/sqlauthandle

.. image:: https://img.shields.io/travis/mentoldo/sqlauthandle.svg

        :target: https://travis-ci.com/mentoldo/sqlauthandle

.. image:: https://readthedocs.org/projects/sqlauthandle/badge/?version=latest

        :target: https://sqlauthandle.readthedocs.io/en/latest/?version=latest

        :alt: Documentation Status

.. image:: https://pyup.io/repos/github/mentoldo/sqlauthandle/shield.svg

     :target: https://pyup.io/repos/github/mentoldo/sqlauthandle/

     :alt: Updates

Easy manage Authentication on SQL DB.

* Free software: MIT license

* Documentation: https://sqlauthandle.readthedocs.io.

Features

--------

sqlauthandle lets you to simple and secure handle authentications of SQL DB servers.

You can manage multiple server configurations in your project.

It create config files and save the passwords in the keyring of your OS

and create an `sqlalchemy `_ connection.

=====

Usage

=====

To use sqlauthandle in a project::

    from sqlauthandle.sqlauthandle import Sqlauth

    import getpass

Choose an alias name and instantiate Sqlauth.

::

    auth = Sqlauth(alias='postgres_dev', reset_file=True)

and set the credentials::

    auth.set_credentials(dialect='postgresql',

                         host='localhost',

                         port='5432',

                         user='usuario',

                         db_name='customers',

                         passwd=getpass.getpass('Password: '))

It will ask you for password interactively. The password will be saved encryptedly in your

system keyring.

(Hint: Qt console does not support input password mode. If you don't want yo show your password on the screen, you

need to use another console.)

The dialect, host, port, user, db_name and passwd are saved in a config file in ``.sqlauthande/``.

You can add this folder to ``.gitignore`` file if you don't want to follow config files with Git

Then, you can authenticate at DB with::

    auth.conect_db()

It returns a ``sqlalchemy.engine.base.Engine`` from `sqlalchemy `_ package.

You can use it, for example, with pandas::

    pd.read_sql('clients', auth.conect_db())

CLI interface

-------------

You can set your credentials interactively directly from shell

.. code-block:: console

    $ sqlauthandle

    Sqlauthandle

    See sqlauthandle documentation at https://sqlauthandle.readthedocs.io/

    Alias [sqlauthandle]: postgres_dev

    Dialect [postgresql]:

    Host [localhost]:

    Port [5432]:

    User: usuario

    Database name: customers

    Password:

Then, on your Python project, you can instantiate Sqlauth with the alias::

    auth = Sqlauth(alias='postgres_dev', reset_file=True)

Credits

-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter

.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage