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

Uploaded Source

Built Distribution

citelang-0.0.27-py3-none-any.whl (86.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: citelang-0.0.27.tar.gz
  • Upload date:
  • Size: 63.2 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.64.0 CPython/3.9.12

File hashes

Hashes for citelang-0.0.27.tar.gz
Algorithm Hash digest
SHA256 0490ae07fa7b22ba447617a972b0105a46dde7c8cba44b265893a3fc3f9ef756
MD5 fb50ffb0a0c1fc3af758d25656505d4f
BLAKE2b-256 1f745931171732c781f34440c2ada16ab173afaf32d070320622b38daec8abe8

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: citelang-0.0.27-py3-none-any.whl
  • Upload date:
  • Size: 86.4 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.64.0 CPython/3.9.12

File hashes

Hashes for citelang-0.0.27-py3-none-any.whl
Algorithm Hash digest
SHA256 4415fd84bc180b74f52e2d233ba44b73618262560444c3c48e0526060b3802c3
MD5 7de4d1e19a67d036ac01bcf3d727eb5a
BLAKE2b-256 4e9d3f5c5c8155187f253c1abcbe05edd76c4e15019400a62391d9e058dec506

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