Documentation table of contents

• The ESCAPE OSSR library
  • Former stable versions
  • Install
    • For users
    • For developers
  • Online CodeMeta validator for the OSSR
  • License
  • Cite
• eOSSR API Documentation
  • eossr.api package
    • eossr.api.zenodo package
    • eossr.api.ossr module
  • eossr.metadata package
    • Subpackages
    • Submodules
    • eossr.metadata.codemeta module
    • eossr.metadata.codemeta2zenodo module
    • eossr.metadata.zenodo module
    • Module contents
  • eossr.utils module
    • ZipUrl
    • get_codemeta_from_zipurl()
    • update_codemeta()
    • zip_repository()
  • eOSSR CLI programs
    • eossr-codemeta2zenodo
    • eossr-upload-repository
    • eossr-metadata-validator
    • eossr-zenodo-validator
    • eossr-zip-repository
    • eossr-check-connection-zenodo
• OSSR metadata
  • OSSR metadata introduction
    • Quickstart - How to incorporate a CodeMeta metadata file into your project.
    • Create a Zenodo metadata file from the a CodeMeta schema file
  • OSSR metadata table
  • Validate CodeMeta file
  • Add funding to metadata
    • Find your funding
    • Add funding to codemeta.json
  • Example of protocols to harvest metadata from Zenodo
    • Pros and cons of each method
    • OAI-PMH protocol
    • Zenodo’s REST API
    • eossr
• OSSR Statistics
• Examples
  • How to use ZipUrl
    • How it is used in eossr
  • Make a graph network of communities connected through records
    • Add clustering
    • Display graph
  • Find ESCAPE OSSR records
    • Getting all the records
    • Specific search
    • Record methods
    • Getting CodeMeta metadata
    • MyBinder integration
  • Upload records on the OSSR
    • Create a new deposit
    • Add files to the deposit
    • Add metadata to the deposit
    • Publish the deposit - or not.
• 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
    • GitHub
• Useful resources
  • Schema.org & CodeMeta tools
    • CodeMeta generators and converters
    • The metadata jungle
  • Zenodo

Indices and tables

• Index

• Module Index

• Search Page