Metadata-Version: 2.1
Name: kenjyco-libs
Version: 0.0.9
Summary: Easily install kenjyco libs
Home-page: https://github.com/kenjyco/kenjyco-libs
Author: Ken
Author-email: kenjyco@gmail.com
License: MIT
Download-URL: https://github.com/kenjyco/kenjyco-libs/tarball/v0.0.9
Keywords: api,data,libs,cli,command-line,helper,kenjyco
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
License-File: LICENSE.txt
Requires-Dist: bg-helper
Requires-Dist: click >=6.0
Requires-Dist: fs-helper
Requires-Dist: input-helper
Requires-Dist: settings-helper
Provides-Extra: bs4
Requires-Dist: beautifulsoup4 ; extra == 'bs4'
Requires-Dist: lxml ; extra == 'bs4'
Provides-Extra: data
Requires-Dist: aws-info-helper ; extra == 'data'
Requires-Dist: dt-helper ; extra == 'data'
Requires-Dist: webclient-helper ; extra == 'data'
Requires-Dist: sql-helper ; extra == 'data'
Requires-Dist: chloop ; extra == 'data'
Requires-Dist: mongo-helper ; extra == 'data'
Requires-Dist: redis-helper ; extra == 'data'
Requires-Dist: xmljson ; extra == 'data'
Requires-Dist: expectation-helper ; (python_version >= "3.8") and extra == 'data'
Provides-Extra: dev
Requires-Dist: readme-helper ; extra == 'dev'
Requires-Dist: testing-helper ; extra == 'dev'
Provides-Extra: full
Requires-Dist: beautifulsoup4 ; extra == 'full'
Requires-Dist: lxml ; extra == 'full'
Requires-Dist: aws-info-helper ; extra == 'full'
Requires-Dist: dt-helper ; extra == 'full'
Requires-Dist: webclient-helper ; extra == 'full'
Requires-Dist: sql-helper ; extra == 'full'
Requires-Dist: chloop ; extra == 'full'
Requires-Dist: mongo-helper ; extra == 'full'
Requires-Dist: redis-helper ; extra == 'full'
Requires-Dist: xmljson ; extra == 'full'
Requires-Dist: readme-helper ; extra == 'full'
Requires-Dist: testing-helper ; extra == 'full'
Requires-Dist: ipython ; extra == 'full'
Requires-Dist: expectation-helper ; (python_version >= "3.8") and extra == 'full'
Provides-Extra: ipython
Requires-Dist: ipython ; extra == 'ipython'
Provides-Extra: nosql
Requires-Dist: chloop ; extra == 'nosql'
Requires-Dist: mongo-helper ; extra == 'nosql'
Requires-Dist: redis-helper ; extra == 'nosql'
Provides-Extra: sql
Requires-Dist: sql-helper ; extra == 'sql'
Requires-Dist: expectation-helper ; (python_version >= "3.8") and extra == 'sql'
Provides-Extra: xmljson
Requires-Dist: xmljson ; extra == 'xmljson'

Install Options
---------------

Use ``pip`` to install
`kenjyco-libs <https://github.com/kenjyco/libs>`__, ideally to a
`virtual environment
(venv) <https://docs.python.org/3/library/venv.html>`__. You can choose
``kenjyco-libs`` (very light weight), ``"kenjyco-libs[full]"``
(everything), or something in between.

-  ``pip install kenjyco-libs``

   -  Includes:
      `bg-helper <https://github.com/kenjyco/bg-helper/blob/master/README.md>`__,
      click,
      `fs-helper <https://github.com/kenjyco/fs-helper/blob/master/README.md>`__,
      `input-helper <https://github.com/kenjyco/input-helper/blob/master/README.md>`__,
      `settings-helper <https://github.com/kenjyco/settings-helper/blob/master/README.md>`__

-  ``pip install "kenjyco-libs[bs4]"``

   -  Includes: beautifulsoup4, kenjyco-libs, lxml
   -  Also requires system requirements for ``lxml``

   ::

      $ sudo apt-get install -y libxml2 libxslt1.1 libxml2-dev libxslt1-dev

      or

      $ brew install libxml2

-  ``pip install "kenjyco-libs[data]"``

   -  Includes:
      `aws-info-helper <https://github.com/kenjyco/aws-info-helper/blob/master/README.md>`__,
      `dt-helper <https://github.com/kenjyco/dt-helper/blob/master/README.md>`__,
      “kenjyco-libs[nosql,sql,xmljson]”,
      `webclient-helper <https://github.com/kenjyco/webclient-helper/blob/master/README.md>`__

-  ``pip install "kenjyco-libs[dev]"``

   -  Includes: kenjyco-libs,
      `readme-helper <https://github.com/kenjyco/readme-helper/blob/master/README.md>`__,
      `testing-helper <https://github.com/kenjyco/testing-helper/blob/master/README.md>`__

-  ``pip install "kenjyco-libs[full]"``

   -  Includes: “kenjyco-libs[bs4,data,dev,ipython]”

-  ``pip install "kenjyco-libs[ipython]"``

   -  Includes: ipython, kenjyco-libs

-  ``pip install "kenjyco-libs[nosql]"``

   -  Includes:
      `chloop <https://github.com/kenjyco/chloop/blob/master/README.md>`__,
      kenjyco-libs,
      `mongo-helper <https://github.com/kenjyco/mongo-helper/blob/master/README.md>`__,
      `redis-helper <https://github.com/kenjyco/redis-helper/blob/master/README.md>`__

-  ``pip install "kenjyco-libs[sql]"``

   -  Includes:
      `expectation-helper <https://github.com/kenjyco/expectation-helper/blob/master/README.md>`__,
      kenjyco-libs,
      `sql-helper <https://github.com/kenjyco/sql-helper/blob/master/README.md>`__
   -  Also requires the ``pg_config`` executable
   -  expectation-helper is only included if using Python 3.8+

   ::

      $ sudo apt-get install -y libpq-dev

      or

      $ brew install postgresql

-  ``pip install "kenjyco-libs[xmljson]"``

   -  Includes: kenjyco-libs, xmljson

Setup and Usage
---------------

The first time that ``kenjyco_libs`` is imported, the sample
`settings.ini <https://github.com/kenjyco/libs/blob/master/kenjyco_libs/settings.ini>`__
file will be copied to the ``~/.config/kenjyco-libs`` directory.

::

   [default]
   package_repos_base_path = ~/repos/personal/packages
   kenjyco_libs_repo_names = aws-info-helper, bg-helper, chloop, dt-helper, expectation-helper, fs-helper, input-helper, libs, mongo-helper, readme-helper, redis-helper, settings-helper, sql-helper, testing-helper, webclient-helper
   dependency_repos_base_path = ~/repos/some-repos

   [dev]
   something =

   [test]
   something =

After installing with ``pip``, you will want to **run the provided
``kenjyco-dev-setup`` script**. This will automatically clone kenjyco
repos and their dependencies to the paths specified in settings.ini,
then reinstall the packages in “editable mode” (i.e. the packages in the
venv’s site-packages directory will be linked to the cloned kenjyco
repos).

Use **kenjyco-ipython** to start ipython with all of the installed
kenjyco packages automatically imported (keeping your ipython shell
history clean from boilerplate import statements).

::

   % venv/bin/kenjyco-dev-setup --help
   Usage: kenjyco-dev-setup [OPTIONS]

     Clone missing repos and install more packages in editable mode

     Options:
       --help  Show this message and exit.


   % venv/bin/kenjyco-ipython --help
   Usage: kenjyco-ipython [OPTIONS]

     Start ipython with several things imported

   Options:
     --no-vi      Do not use vi editing mode
     --no-colors  Do not use colors / syntax highlighting
     --help       Show this message and exit.


