..
Copyright (C) 2019-2020 CERN.
Copyright (C) 2019-2020 Northwestern University.
Invenio-Cli is free software; you can redistribute it and/or modify
it under the terms of the MIT License; see LICENSE file for more details.
=================
Invenio-Cli
=================
.. image:: https://img.shields.io/travis/inveniosoftware/invenio-cli.svg
:target: https://travis-ci.org/inveniosoftware/invenio-cli
.. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-cli.svg
:target: https://coveralls.io/r/inveniosoftware/invenio-cli
.. image:: https://img.shields.io/github/tag/inveniosoftware/invenio-cli.svg
:target: https://github.com/inveniosoftware/invenio-cli/releases
.. image:: https://img.shields.io/pypi/dm/invenio-cli.svg
:target: https://pypi.python.org/pypi/invenio-cli
.. image:: https://img.shields.io/github/license/inveniosoftware/invenio-cli.svg
:target: https://github.com/inveniosoftware/invenio-cli/blob/master/LICENSE
Command-line tool to create and manage an InvenioRDM instance.
Installation
============
.. code-block:: console
$ pip install invenio-cli
Usage
=====
Local Development environment
-----------------------------
.. code-block:: console
# Initialize environment and cd into <created folder>
$ invenio-cli init rdm
$ cd <created folder>
# Install locally
# install python dependencies (pre-release versions needed for now),
# link/copy assets + statics, install js dependencies, build assets and
# final statics
$ invenio-cli install --pre
# Start and setup services (database, Elasticsearch, Redis, queue)
$ invenio-cli services
# Optional: add demo data
$ invenio-cli demo --local
# Run the server
$ invenio-cli run
# Update assets or statics
$ invenio-cli update
Containerized 'Production' environment
--------------------------------------
.. code-block:: console
# Initialize environment and cd into <created folder>
$ invenio-cli init rdm
$ cd <created folder>
# Spin-up InvenioRDM
$ invenio-cli containerize
# Optional: add demo data
$ invenio-cli demo --containers
# After updating statics or code, if you do not need to re-install JS
# dependencies which can take time
$ invenio-cli containerize --no-install-js
More Help
---------
.. code-block:: console
# Get more help
$ invenio-cli --help
Further documentation is available on https://invenio-cli.readthedocs.io/
..
Copyright (C) 2019-2023 CERN.
Copyright (C) 2019-2021 Northwestern University.
Invenio-Cli is free software; you can redistribute it and/or modify
it under the terms of the MIT License; see LICENSE file for more details.
Changes
=======
Version 1.3.0 (released 2024-05-24)
- deps: pin docker to >=7.1.0 due to bug on requests
- services: add instance path to env on setup
Version 1.2.0 (released 2023-10-02)
- reload on invenio.cfg changes
Version 1.1.0 (released 2023-07-24)
- add compatibility for docker compose v2
- consider command errors when using install command and fail
Version 1.0.21 (released 2023-05-18)
- deps: support docker < 7 for compatibility with urllib3 v2
Version 1.0.20 (released 2023-03-134)
- setup: add queues initialisation to steps
Version 1.0.19 (released 2023-03-10)
- global: remove fail message on warning (i.e. soft failures)
Version 1.0.18 (released 2023-02-07)
- containerize: fix translation commands instance path
Version 1.0.17 (released 2023-01-30)
- requirements: check node version depending on app-rdm version
Version 1.0.16 (released 2023-01-30)
- bump cookiecutter to v11.0
Version 1.0.15 (released 2023-01-13)
- Setup: fix empty translation folder failing
Version 1.0.14 (released 2023-01-09)
- Add app-rdm fixtures to setup
Version 1.0.13 (released 2022-11-14)
- Allow compilation command to fail in case of missing catalogs.
Version 1.0.12 (released 2022-10-28)
- Adds support for translations (i18n) management commands.
Version 1.0.11 (released 2022-10-24)
- Add support for InvenioILS
Version 1.0.8 (released 2022-10-13)
- Fix issue when checking for services to be up
and running correctly.
Version 1.0.7 (released 2022-10-10)
- Fix compat issue with RDM versions < v10
Version 1.0.6 (released 2022-10-10)
- Bump default RDM version.
Version 1.0.5 (released 2022-05-31)
- Bump click version.
- Bump default RDM version.
- Improve error handling.
- Add check for npm version.
- Move ImageMagick check to --development.
Version 1.0.4 (released 2022-02-14)
- Fixes an issue with virtualenv 20.13.1+ brining in setuptools 60.x which is
incompatible with Celery v5.2.3. Once Celery v5.2.4 has been released, this
fix is no longer needed.
Version 1.0.3 (released 2022-02-04)
- Added ``--no-input`` and ``--config=`` options to ``init`` to support running
with predefined config and without requiring user input.
Version 1.0.0 (released 2021-08-05)
- Initial public release.
Raw data
{
"_id": null,
"home_page": "https://github.com/inveniosoftware/invenio-cli",
"name": "invenio-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "invenio-cli",
"author": "CERN & Northwestern University",
"author_email": "info@inveniosoftware.org",
"download_url": "https://files.pythonhosted.org/packages/97/23/9c66c11eb31cc77761cab9398c153468d94e4aaeee324ea3eb7009334c05/invenio-cli-1.3.0.tar.gz",
"platform": "any",
"description": "..\n Copyright (C) 2019-2020 CERN.\n Copyright (C) 2019-2020 Northwestern University.\n\n Invenio-Cli is free software; you can redistribute it and/or modify\n it under the terms of the MIT License; see LICENSE file for more details.\n\n=================\n Invenio-Cli\n=================\n\n.. image:: https://img.shields.io/travis/inveniosoftware/invenio-cli.svg\n :target: https://travis-ci.org/inveniosoftware/invenio-cli\n\n.. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-cli.svg\n :target: https://coveralls.io/r/inveniosoftware/invenio-cli\n\n.. image:: https://img.shields.io/github/tag/inveniosoftware/invenio-cli.svg\n :target: https://github.com/inveniosoftware/invenio-cli/releases\n\n.. image:: https://img.shields.io/pypi/dm/invenio-cli.svg\n :target: https://pypi.python.org/pypi/invenio-cli\n\n.. image:: https://img.shields.io/github/license/inveniosoftware/invenio-cli.svg\n :target: https://github.com/inveniosoftware/invenio-cli/blob/master/LICENSE\n\nCommand-line tool to create and manage an InvenioRDM instance.\n\nInstallation\n============\n\n.. code-block:: console\n\n $ pip install invenio-cli\n\nUsage\n=====\n\nLocal Development environment\n-----------------------------\n\n.. code-block:: console\n\n # Initialize environment and cd into <created folder>\n $ invenio-cli init rdm\n $ cd <created folder>\n\n # Install locally\n # install python dependencies (pre-release versions needed for now),\n # link/copy assets + statics, install js dependencies, build assets and\n # final statics\n $ invenio-cli install --pre\n\n # Start and setup services (database, Elasticsearch, Redis, queue)\n $ invenio-cli services\n\n # Optional: add demo data\n $ invenio-cli demo --local\n\n # Run the server\n $ invenio-cli run\n\n # Update assets or statics\n $ invenio-cli update\n\n\nContainerized 'Production' environment\n--------------------------------------\n\n.. code-block:: console\n\n # Initialize environment and cd into <created folder>\n $ invenio-cli init rdm\n $ cd <created folder>\n\n # Spin-up InvenioRDM\n $ invenio-cli containerize\n\n # Optional: add demo data\n $ invenio-cli demo --containers\n\n # After updating statics or code, if you do not need to re-install JS\n # dependencies which can take time\n $ invenio-cli containerize --no-install-js\n\n\nMore Help\n---------\n\n.. code-block:: console\n\n # Get more help\n $ invenio-cli --help\n\nFurther documentation is available on https://invenio-cli.readthedocs.io/\n\n..\n Copyright (C) 2019-2023 CERN.\n Copyright (C) 2019-2021 Northwestern University.\n\n Invenio-Cli is free software; you can redistribute it and/or modify\n it under the terms of the MIT License; see LICENSE file for more details.\n\nChanges\n=======\n\nVersion 1.3.0 (released 2024-05-24)\n\n- deps: pin docker to >=7.1.0 due to bug on requests\n- services: add instance path to env on setup\n\nVersion 1.2.0 (released 2023-10-02)\n\n- reload on invenio.cfg changes\n\nVersion 1.1.0 (released 2023-07-24)\n\n- add compatibility for docker compose v2\n- consider command errors when using install command and fail\n\nVersion 1.0.21 (released 2023-05-18)\n\n- deps: support docker < 7 for compatibility with urllib3 v2\n\nVersion 1.0.20 (released 2023-03-134)\n\n- setup: add queues initialisation to steps\n\nVersion 1.0.19 (released 2023-03-10)\n\n- global: remove fail message on warning (i.e. soft failures)\n\nVersion 1.0.18 (released 2023-02-07)\n\n- containerize: fix translation commands instance path\n\nVersion 1.0.17 (released 2023-01-30)\n\n- requirements: check node version depending on app-rdm version\n\nVersion 1.0.16 (released 2023-01-30)\n\n- bump cookiecutter to v11.0\n\nVersion 1.0.15 (released 2023-01-13)\n\n- Setup: fix empty translation folder failing\n\nVersion 1.0.14 (released 2023-01-09)\n\n- Add app-rdm fixtures to setup\n\nVersion 1.0.13 (released 2022-11-14)\n\n- Allow compilation command to fail in case of missing catalogs.\n\nVersion 1.0.12 (released 2022-10-28)\n\n- Adds support for translations (i18n) management commands.\n\nVersion 1.0.11 (released 2022-10-24)\n\n- Add support for InvenioILS\n\nVersion 1.0.8 (released 2022-10-13)\n\n- Fix issue when checking for services to be up\n and running correctly.\n\nVersion 1.0.7 (released 2022-10-10)\n\n- Fix compat issue with RDM versions < v10\n\nVersion 1.0.6 (released 2022-10-10)\n\n- Bump default RDM version.\n\nVersion 1.0.5 (released 2022-05-31)\n\n- Bump click version.\n- Bump default RDM version.\n- Improve error handling.\n- Add check for npm version.\n- Move ImageMagick check to --development.\n\nVersion 1.0.4 (released 2022-02-14)\n\n- Fixes an issue with virtualenv 20.13.1+ brining in setuptools 60.x which is\n incompatible with Celery v5.2.3. Once Celery v5.2.4 has been released, this\n fix is no longer needed.\n\nVersion 1.0.3 (released 2022-02-04)\n\n- Added ``--no-input`` and ``--config=`` options to ``init`` to support running\n with predefined config and without requiring user input.\n\nVersion 1.0.0 (released 2021-08-05)\n\n- Initial public release.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "\"Invenio module to ease the creation and management of applications.\"",
"version": "1.3.0",
"project_urls": {
"Homepage": "https://github.com/inveniosoftware/invenio-cli"
},
"split_keywords": [
"invenio-cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d44d3f4496bc43ff6d5f03ac1e40d818009d935cb7417f5b8ce5b86363fef4e5",
"md5": "1f0b20981c50916ef4f7a3fc7b43d367",
"sha256": "80e67e8bdb7d942eb3bd5d111876ccbee4f1a14d7fd75a80e77be6238a4191e6"
},
"downloads": -1,
"filename": "invenio_cli-1.3.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "1f0b20981c50916ef4f7a3fc7b43d367",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 45774,
"upload_time": "2024-05-24T08:17:09",
"upload_time_iso_8601": "2024-05-24T08:17:09.680090Z",
"url": "https://files.pythonhosted.org/packages/d4/4d/3f4496bc43ff6d5f03ac1e40d818009d935cb7417f5b8ce5b86363fef4e5/invenio_cli-1.3.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "97239c66c11eb31cc77761cab9398c153468d94e4aaeee324ea3eb7009334c05",
"md5": "aa85b9b764c44ae9e4b68f8357b6a803",
"sha256": "3866a5d6421d2e9b88bb34286f5f9b3cbf408530ba84d2a3868483be8b875937"
},
"downloads": -1,
"filename": "invenio-cli-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "aa85b9b764c44ae9e4b68f8357b6a803",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 45172,
"upload_time": "2024-05-24T08:17:16",
"upload_time_iso_8601": "2024-05-24T08:17:16.292312Z",
"url": "https://files.pythonhosted.org/packages/97/23/9c66c11eb31cc77761cab9398c153468d94e4aaeee324ea3eb7009334c05/invenio-cli-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-24 08:17:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "inveniosoftware",
"github_project": "invenio-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "invenio-cli"
}
JSON
