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/pypi-citelang.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 ⭐️

TODO

  • save commit content and message for further filtering
  • 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.25.tar.gz (63.0 kB view details)

Uploaded Source

Built Distribution

citelang-0.0.25-py3-none-any.whl (86.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: citelang-0.0.25.tar.gz
  • Upload date:
  • Size: 63.0 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.25.tar.gz
Algorithm Hash digest
SHA256 d69cdc0644f7bd7523f4778eb3f61ffa401109070a226e458fdef2bdf3c17fb2
MD5 25cd5f1a3951cda16cf816c1eb791a71
BLAKE2b-256 f68ec88d6670f0c48c48dbd8c8b949dd0a3a22974361b2fb4c1890343e606c60

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: citelang-0.0.25-py3-none-any.whl
  • Upload date:
  • Size: 86.2 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.25-py3-none-any.whl
Algorithm Hash digest
SHA256 549150b21b20d4f9c3a06112372ad81eb1a804b14bba94b329b60210b1fdc05a
MD5 c01bcb8f725489219cf027ae7d495133
BLAKE2b-256 2445118a054f413f71dfd3894732c52786d25da1b68a4db733ffe5da8fdc7466

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