Skip to main content

Credit parser and markdown language for scientific software.

Project description

CiteLang

PyPI version

https://raw.githubusercontent.com/vsoch/citelang/main/docs/assets/img/citelang-tree.png

Welcome to CiteLang! This is the first markdown syntax for citing software. Importantly, when you use CiteLang to reference software.

  1. Generate basic software credit trees
  2. Give credit accounting for dependencies!

No - we aren't using DOIs! A manually crafted identifier that a human has to remember to generate, in addition to a publication or release, is too much work for people to reasonably do. As research software engineers we also want to move away from the traditional "be valued like an academic" model. We are getting software metadata and a reference to an identifier via a package manager. This means that when you publish your software, you should publish it to an appropriate package manager.

⭐️ Documentation ⭐️

TODO

  • add graphic summary
  • add GitHub actions

Contributors

We use the all-contributors tool to generate a contributors graphic below.


Vanessasaurus

💻

License

This code is licensed under the MPL 2.0 LICENSE.

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

citelang-0.0.12.tar.gz (42.8 kB view details)

Uploaded Source

Built Distribution

citelang-0.0.12-py3-none-any.whl (56.2 kB view details)

Uploaded Python 3

File details

Details for the file citelang-0.0.12.tar.gz.

File metadata

  • Download URL: citelang-0.0.12.tar.gz
  • Upload date:
  • Size: 42.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.63.0 CPython/3.9.7

File hashes

Hashes for citelang-0.0.12.tar.gz
Algorithm Hash digest
SHA256 3f816a29cb52b1fdf343e3f142d9272d20478ae3e28c79201af7aa2df086b591
MD5 ba943b3a0474eea4cdd852dbb46c34a6
BLAKE2b-256 3d5985201caecd27acc7708cef2d8e58319ecdf7224f8dd84f865fdbbc7e79f1

See more details on using hashes here.

Provenance

File details

Details for the file citelang-0.0.12-py3-none-any.whl.

File metadata

  • Download URL: citelang-0.0.12-py3-none-any.whl
  • Upload date:
  • Size: 56.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.63.0 CPython/3.9.7

File hashes

Hashes for citelang-0.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 820636921f8bbb1fec7d2be748b1d6fa3c6c5bda333e9b1d054646f6270fa743
MD5 001bdab28363608ba8ef4f3acd3ccd90
BLAKE2b-256 61b1b5afbd92355947d6bad5ecc7fed9793a8a1a50e2a4abb679079b94cf1a61

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