Skip to main content

Command-line tool for uploading to zenodo.

Project description

OpenSCM Zenodo

Command-line tool for uploading to zenodo.

Key info : Docs Main branch: supported Python versions Licence

PyPI : PyPI PyPI install

Tests : CI Coverage

Other info : Last Commit Contributors

Status

  • development: the project is actively being worked on

Full documentation can be found at: openscm-zenodo.readthedocs.io. We recommend reading the docs there because the internal documentation links don't render correctly on GitHub's viewer.

Installation

As an application

If you want to use OpenSCM Zenodo as an application, then we recommend using the 'locked' version of the package. This version pins the version of all dependencies too, which reduces the chance of installation issues because of breaking updates to dependencies.

The locked version of OpenSCM Zenodo can be installed with

=== "pip" sh pip install 'openscm-zenodo[locked]'

As a library

If you want to use OpenSCM Zenodo as a library, for example you want to use it as a dependency in another package/application that you're building, then we recommend installing the package with the commands below. This method provides the loosest pins possible of all dependencies. This gives you, the package/application developer, as much freedom as possible to set the versions of different packages. However, the tradeoff with this freedom is that you may install incompatible versions of OpenSCM Zenodo's dependencies (we cannot test all combinations of dependencies, particularly ones which haven't been released yet!). Hence, you may run into installation issues. If you believe these are because of a problem in OpenSCM Zenodo, please raise an issue.

The (non-locked) version of OpenSCM Zenodo can be installed with

=== "pip" sh pip install openscm-zenodo

For developers

For development, we rely on uv for all our dependency management. To get started, you will need to make sure that uv is installed (instructions here (we found that the self-managed install was best, particularly for upgrading uv later).

For all of our work, we use our Makefile. You can read the instructions out and run the commands by hand if you wish, but we generally discourage this because it can be error prone. In order to create your environment, run make virtual-environment.

If there are any issues, the messages from the Makefile should guide you through. If not, please raise an issue in the issue tracker.

For the rest of our developer docs, please see [development][development].

Original template

This project was generated from this template: copier core python repository. copier is used to manage and distribute this template.

Project details


Download files

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

Source Distribution

openscm_zenodo-0.5.0.tar.gz (22.0 kB view details)

Uploaded Source

Built Distribution

openscm_zenodo-0.5.0-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

Details for the file openscm_zenodo-0.5.0.tar.gz.

File metadata

  • Download URL: openscm_zenodo-0.5.0.tar.gz
  • Upload date:
  • Size: 22.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.5.21

File hashes

Hashes for openscm_zenodo-0.5.0.tar.gz
Algorithm Hash digest
SHA256 adf48f7dd847051eb3c7af33e114fc49c148b292a24391269c9dbee525f8d613
MD5 964cd235e93cddab94307ddff0d1e5f4
BLAKE2b-256 410793bd37f1809b8701de85110e343e04fdf906bd382a228b09650bebca592c

See more details on using hashes here.

File details

Details for the file openscm_zenodo-0.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for openscm_zenodo-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 27c847a699f928c324e24d5b0896fb432901061aa7302d6bc45cf657aee97906
MD5 5aac51c164d05712dce54e276475e740
BLAKE2b-256 170897926b870ec546106df82f8554d01208bfa19f17da574af851fd8818761f

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