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

  • citelang should be able to parse requirements.txt or go.sum, etc.
  • colors should be meaningful
  • add gha to run here!

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

Uploaded Source

Built Distribution

citelang-0.0.15-py3-none-any.whl (60.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: citelang-0.0.15.tar.gz
  • Upload date:
  • Size: 46.0 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.15.tar.gz
Algorithm Hash digest
SHA256 5feda60ced26115a0015ece88d5b78079dc4f2a5e38070edbf679d06fd64c504
MD5 cc19dcf0e9cdad55f8910663066bfc14
BLAKE2b-256 d9668588c72302e5203c3be4b313f2ca96c9bfd851f478fa30fcbec83769813a

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: citelang-0.0.15-py3-none-any.whl
  • Upload date:
  • Size: 60.4 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.15-py3-none-any.whl
Algorithm Hash digest
SHA256 cf30b94ecc5a11cae641105992dcb863355268393d9b311f83a9837b34ecbf70
MD5 1b7909f6b2c8ec6e6b8e9acfbc63ce8b
BLAKE2b-256 896ed6cbd1aba47ff7e77c67443f1ece2d5702072ac1f68eae2f27c3b49294b9

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