Skip to main content

"Invenio module to ease the creation and management of applications."

Project description

https://img.shields.io/travis/inveniosoftware/invenio-cli.svg https://img.shields.io/coveralls/inveniosoftware/invenio-cli.svg https://img.shields.io/github/tag/inveniosoftware/invenio-cli.svg https://img.shields.io/pypi/dm/invenio-cli.svg https://img.shields.io/github/license/inveniosoftware/invenio-cli.svg

Command-line tool to create and manage an InvenioRDM instance.

Installation

$ pip install invenio-cli

Usage

Local Development environment

# 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

# 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

# Get more help
$ invenio-cli --help

Further documentation is available on https://invenio-cli.readthedocs.io/

Changes

Version 1.7.2 (released 2025-04-22)

  • setup: bump minimum version of pipenv to pull in the packaging dependency

Version 1.7.1 (released 2025-03-31)

  • versions: fix accidental creation of a tuple from the version string

Version 1.7.0 (released 2025-03-28)

  • build: allow use of either npm or pnpm as JS package manager (via .invenio)

Version 1.6.1 (released 2025-03-27)

  • versions: consider pyproject.toml when checking App-{RDM,ILS} dependency versions

Version 1.6.0 (released 2025-02-28)

  • packages: allow use of either pipenv or uv as python package manager

  • flask: replace FLASK_ENV with FLASK_DEBUG

  • celery: allow setting a log level

  • config: make host & port for both web and search configurable via .invenio.private

  • run: introduce more fine-granular “web” and “worker” sub-commands

Version 1.5.0 (released 2024-08-01)

  • dependencies: update for invenio-app-rdm v12

Version 1.4.0 (released 2024-07-12)

  • services: add support for InvneioILS setup

Version 1.3.1 (released 2024-06-05)

  • config: fix missing “instance_path” usage

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

invenio_cli-1.7.2.tar.gz (52.3 kB view details)

Uploaded Source

Built Distribution

invenio_cli-1.7.2-py2.py3-none-any.whl (51.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file invenio_cli-1.7.2.tar.gz.

File metadata

  • Download URL: invenio_cli-1.7.2.tar.gz
  • Upload date:
  • Size: 52.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for invenio_cli-1.7.2.tar.gz
Algorithm Hash digest
SHA256 874635debf31cf80a443c515adb9e4f7d2f15ebe428a4366d870d9a081f7d2bd
MD5 c5a08f28b110626ebc1d6f5d3eb71c89
BLAKE2b-256 7e7b045d38db664cfc3e99eed7bc063136ddc586d848ee4ddefca9e9ccbbb72e

See more details on using hashes here.

File details

Details for the file invenio_cli-1.7.2-py2.py3-none-any.whl.

File metadata

  • Download URL: invenio_cli-1.7.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 51.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for invenio_cli-1.7.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d783682585ac505c08460e8e9660d99e9a2d8ac602eea8bd4fc671d8f764c88e
MD5 63b5adbf9956e8bd321772ad70739511
BLAKE2b-256 477632f9c0094ef652b26334d2bc1184583fd19f198aa073e2f13eda60251b91

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page