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.
Raw data
{
"_id": null,
"home_page": "https://github.com/kenjyco/kenjyco-libs",
"name": "kenjyco-libs",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "api, data, libs, cli, command-line, helper, kenjyco",
"author": "Ken",
"author_email": "kenjyco@gmail.com",
"download_url": "https://github.com/kenjyco/kenjyco-libs/tarball/v0.0.10",
"platform": null,
"description": "Install Options\n---------------\n\nUse ``pip`` to install\n`kenjyco-libs <https://github.com/kenjyco/libs>`__, ideally to a\n`virtual environment\n(venv) <https://docs.python.org/3/library/venv.html>`__. You can choose\n``kenjyco-libs`` (very light weight), ``\"kenjyco-libs[full]\"``\n(everything), or something in between.\n\n- ``pip install kenjyco-libs``\n\n - Includes:\n `bg-helper <https://github.com/kenjyco/bg-helper/blob/master/README.md>`__,\n click,\n `fs-helper <https://github.com/kenjyco/fs-helper/blob/master/README.md>`__,\n `input-helper <https://github.com/kenjyco/input-helper/blob/master/README.md>`__,\n `settings-helper <https://github.com/kenjyco/settings-helper/blob/master/README.md>`__\n\n- ``pip install \"kenjyco-libs[bs4]\"``\n\n - Includes: beautifulsoup4, kenjyco-libs, lxml\n - Also requires system requirements for ``lxml``\n\n ::\n\n $ sudo apt-get install -y libxml2 libxslt1.1 libxml2-dev libxslt1-dev\n\n or\n\n $ brew install libxml2\n\n- ``pip install \"kenjyco-libs[data]\"``\n\n - Includes:\n `aws-info-helper <https://github.com/kenjyco/aws-info-helper/blob/master/README.md>`__,\n `dt-helper <https://github.com/kenjyco/dt-helper/blob/master/README.md>`__,\n \u201ckenjyco-libs[nosql,sql,xmljson]\u201d,\n `webclient-helper <https://github.com/kenjyco/webclient-helper/blob/master/README.md>`__\n\n- ``pip install \"kenjyco-libs[dev]\"``\n\n - Includes: kenjyco-libs,\n `readme-helper <https://github.com/kenjyco/readme-helper/blob/master/README.md>`__,\n `testing-helper <https://github.com/kenjyco/testing-helper/blob/master/README.md>`__\n\n- ``pip install \"kenjyco-libs[full]\"``\n\n - Includes: \u201ckenjyco-libs[bs4,data,dev,ipython]\u201d\n\n- ``pip install \"kenjyco-libs[ipython]\"``\n\n - Includes: ipython, kenjyco-libs\n\n- ``pip install \"kenjyco-libs[nosql]\"``\n\n - Includes:\n `chloop <https://github.com/kenjyco/chloop/blob/master/README.md>`__,\n kenjyco-libs,\n `mongo-helper <https://github.com/kenjyco/mongo-helper/blob/master/README.md>`__,\n `redis-helper <https://github.com/kenjyco/redis-helper/blob/master/README.md>`__\n\n- ``pip install \"kenjyco-libs[sql]\"``\n\n - Includes:\n `expectation-helper <https://github.com/kenjyco/expectation-helper/blob/master/README.md>`__,\n kenjyco-libs,\n `sql-helper <https://github.com/kenjyco/sql-helper/blob/master/README.md>`__\n - Also requires the ``pg_config`` executable\n - expectation-helper is only included if using Python 3.8+\n\n ::\n\n $ sudo apt-get install -y libpq-dev\n\n or\n\n $ brew install postgresql\n\n- ``pip install \"kenjyco-libs[xmljson]\"``\n\n - Includes: kenjyco-libs, xmljson\n\nSetup and Usage\n---------------\n\nThe first time that ``kenjyco_libs`` is imported, the sample\n`settings.ini <https://github.com/kenjyco/libs/blob/master/kenjyco_libs/settings.ini>`__\nfile will be copied to the ``~/.config/kenjyco-libs`` directory.\n\n::\n\n [default]\n package_repos_base_path = ~/repos/personal/packages\n 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\n dependency_repos_base_path = ~/repos/some-repos\n\n [dev]\n something =\n\n [test]\n something =\n\nAfter installing with ``pip``, you will want to **run the provided\n``kenjyco-dev-setup`` script**. This will automatically clone kenjyco\nrepos and their dependencies to the paths specified in settings.ini,\nthen reinstall the packages in \u201ceditable mode\u201d (i.e.\u00a0the packages in the\nvenv\u2019s site-packages directory will be linked to the cloned kenjyco\nrepos).\n\nUse **kenjyco-ipython** to start ipython with all of the installed\nkenjyco packages automatically imported (keeping your ipython shell\nhistory clean from boilerplate import statements).\n\n::\n\n % venv/bin/kenjyco-dev-setup --help\n Usage: kenjyco-dev-setup [OPTIONS]\n\n Clone missing repos and install more packages in editable mode\n\n Options:\n --help Show this message and exit.\n\n\n % venv/bin/kenjyco-ipython --help\n Usage: kenjyco-ipython [OPTIONS]\n\n Start ipython with several things imported\n\n Options:\n --no-vi Do not use vi editing mode\n --no-colors Do not use colors / syntax highlighting\n --help Show this message and exit.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Easily install kenjyco libs",
"version": "0.0.10",
"project_urls": {
"Download": "https://github.com/kenjyco/kenjyco-libs/tarball/v0.0.10",
"Homepage": "https://github.com/kenjyco/kenjyco-libs"
},
"split_keywords": [
"api",
" data",
" libs",
" cli",
" command-line",
" helper",
" kenjyco"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f63d9c2c03056cb0062eb5263bf43bda6850113dd76d03a958798abf6da864dd",
"md5": "ad6f5f2f481954770bc67511a83c6bdd",
"sha256": "895cef8030bdf022834838e410ae133ed9be641f6647f265117a1fc90c876452"
},
"downloads": -1,
"filename": "kenjyco_libs-0.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ad6f5f2f481954770bc67511a83c6bdd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7490,
"upload_time": "2024-07-15T05:45:24",
"upload_time_iso_8601": "2024-07-15T05:45:24.482301Z",
"url": "https://files.pythonhosted.org/packages/f6/3d/9c2c03056cb0062eb5263bf43bda6850113dd76d03a958798abf6da864dd/kenjyco_libs-0.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-15 05:45:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kenjyco",
"github_project": "kenjyco-libs",
"github_not_found": true,
"lcname": "kenjyco-libs"
}
JSON
