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 (citelang graph, badge, or credit)
  2. Give credit accounting for dependencies! (see software-credit.md)
  3. Actions (automation) for the above!

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 ⭐️

docs/assets/img/pypi-citelang.png

TODO

  • colors should be meaningful

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

Uploaded Source

Built Distribution

citelang-0.0.21-py3-none-any.whl (81.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for citelang-0.0.21.tar.gz
Algorithm Hash digest
SHA256 41d68107d330dbf069dcd7d7198e0be96b0e2e18f2df1fc2c47485fa4cdf5074
MD5 2f3dfc9e6d97df1e216ec2f7c18e1c67
BLAKE2b-256 0ecd93268ab847cc1e1d286634d2a9118988e1d05e36f51d044bd106183d123f

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for citelang-0.0.21-py3-none-any.whl
Algorithm Hash digest
SHA256 1c3056d6305a05d2de33c5d4e0fe34f7c7b452b8e1169d04d96818e7b71cce02
MD5 8fc0de63621627c43628af219f7915e1
BLAKE2b-256 f20dc1b05e584baee2a8a3e3c6ee7dc3b885c06d8e3ecfff264927f67f89a155

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