Metadata-Version: 2.1
Name: invenio-cli
Version: 1.0.9
Summary: "Invenio module to ease the creation and management of applications."
Home-page: https://github.com/inveniosoftware/invenio-cli
Author: CERN & Northwestern University
Author-email: info@inveniosoftware.org
License: MIT
Keywords: invenio-cli
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Requires-Python: >=3.7
Requires-Dist: cookiecutter (<1.8.0,>=1.7.1)
Requires-Dist: click (<8.2,>=7.1.1)
Requires-Dist: click-default-group (<2.0.0,>=1.2.2)
Requires-Dist: docker (<6.0.0,>=4.1.0)
Requires-Dist: pipfile (>=0.0.2)
Requires-Dist: pipenv (>=2020.6.2)
Requires-Dist: PyYAML (>=5.1.2)
Requires-Dist: pynpm (>=0.1.2)
Requires-Dist: virtualenv (<=20.13.0,>=20.0.35)
Provides-Extra: tests
Requires-Dist: pytest-black (==0.3.9) ; extra == 'tests'
Requires-Dist: pytest-invenio (>=1.4.0) ; extra == 'tests'
Requires-Dist: Sphinx (>=4.2.0) ; extra == 'tests'

..
    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-2021 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.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.


