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 pdm for all our dependency management. To get started, you will need to make sure that pdm is installed (instructions here, although we found that installing with pipx worked perfectly for us).

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.3.1.tar.gz (21.3 kB view details)

Uploaded Source

Built Distribution

openscm_zenodo-0.3.1-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openscm_zenodo-0.3.1.tar.gz
  • Upload date:
  • Size: 21.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.19.1 CPython/3.10.12 Linux/6.8.0-1014-azure

File hashes

Hashes for openscm_zenodo-0.3.1.tar.gz
Algorithm Hash digest
SHA256 7146fe82c2b22c0804747bc3a254ba7573b18a2778139c66dac745cea70a7643
MD5 402f57c02bbb20f4302c276e956743d1
BLAKE2b-256 3179960dd8f968547741be75337266d3a4a6e399a18831f85dd1b811d152f088

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: openscm_zenodo-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 17.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.19.1 CPython/3.10.12 Linux/6.8.0-1014-azure

File hashes

Hashes for openscm_zenodo-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 033c2b9e0b0e3316f1caadbb3efab6344e80cca458a31eb40c6e22fd3a937eb4
MD5 85f6ded2607a19de12d3275d2a8f5e91
BLAKE2b-256 1cce7041247d11a2af75560addec25c315a3fd3e82628a05948675aad8874896

See more details on using hashes here.

Provenance

Supported by

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