eossr
The ESCAPE OSSR library
eOSSR API Documentation
OSSR metadata
OSSR Statistics
Examples
GitLab to Zenodo
Snippets
Useful resources
eossr
»
Welcome to eOSSR’s documentation!
View page source
Welcome to eOSSR’s documentation!
The ESCAPE OSSR library
Former stable versions
Install
For users
For developers
Running tests
License
Cite
eOSSR API Documentation
eossr.api package
Subpackages
eossr.api.zenodo package
Module contents
eossr.metadata package
Subpackages
eossr.metadata.schema package
Submodules
eossr.metadata.codemeta2zenodo module
Module contents
eossr.utils module
eOSSR CLI programs
eossr-codemeta2zenodo
eossr-upload-repository
eossr-metadata-validator
eossr-zip-repository
eossr-check-connection-zenodo
OSSR metadata
OSSR metadata introduction
Quickstart - How to incorporate a CodeMeta metadata file into your project.
Keywords list
Create a Zenodo metadata file from the a CodeMeta schema file
Extending the CodeMeta Context schema
OSSR metadata table
Add funding to metadata
Find your funding
Zenodo services
Add funding to
codemeta.json
Example of protocols to harvest metadata from Zenodo
Pros and cons of each method
OAI-PMH protocol
First have a look at a nice tutorial on the protocol.
Zenodo’s REST API
A specific ESCAPE2020 entry:
agnpy
.
eossr
OSSR Statistics
Examples
How to use ZipUrl
How it is used in eossr
Find ESCAPE OSSR records
Getting all the records
Specific search
Using strings
Using keywords
Directly from its id
Record
methods
Getting CodeMeta metadata
MyBinder integration
Upload records on the OSSR
Create a new entry
Zenodo HTTP status
Add files to the entry
Add metadata to the entry
Check the content of the new entry
Publish the entry
GitLab to Zenodo
Upload from GitLab in 4 steps
1. Include an ESCAPE CodeMeta metadata file
2. Link your GitLab project with Zenodo.
3. Into your
.gitlab-ci.yml
file
4. ‘One-click-build-and-publish’
What happens during the GitLab-Zenodo CI process
Trigger the GitLabCI and publish your project to Zenodo.
Snippets
Build a Docker container during the CI process
Build a Singularity image during the CI process
Upload to the OSSR
Important note
Upload to Zenodo
Upload to Sandbox Zenodo
Test your metadata validity on the main (master) branch
GitLab
Test your
codemeta.json
file
Test your
.zenodo.json
file
GitHub
Test your
.zenodo.json
file
Useful resources
Schema.org & CodeMeta tools
CodeMeta generators and converters
Zenodo
Indices and tables
Index
Module Index
Search Page
Other Versions
v: master
Tags
v0.2
v0.3.2
v0.3.3
v0.4
v0.5
v0.6
Branches
master