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

Uploaded Source

Built Distribution

citelang-0.0.24-py3-none-any.whl (82.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: citelang-0.0.24.tar.gz
  • Upload date:
  • Size: 60.8 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.24.tar.gz
Algorithm Hash digest
SHA256 bd111e435e4d0fd1f80caebf95e8d81e28bc9dfb2988e94e1f359181e61ef8a0
MD5 da0132d9c758124b39238548a7bcd5e6
BLAKE2b-256 e953ab81d29cd73d80f15712f5f9ceaf5333d822bdc68f7a05460754372587c7

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: citelang-0.0.24-py3-none-any.whl
  • Upload date:
  • Size: 82.7 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.24-py3-none-any.whl
Algorithm Hash digest
SHA256 8ff2563fb8b63ec4c90196da09cfe7230648a78f9d7813dd9860c99c624d4e51
MD5 84857d9fe32867cc6b984f2d2fbdf29b
BLAKE2b-256 298dd1ff0e9ff54c1bb7eb453ec45f54bd3ba6d7b376662b4a63aca7bce13f0d

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