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

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

Uploaded Source

Built Distribution

citelang-0.0.17-py3-none-any.whl (60.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: citelang-0.0.17.tar.gz
  • Upload date:
  • Size: 46.2 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.11

File hashes

Hashes for citelang-0.0.17.tar.gz
Algorithm Hash digest
SHA256 8718edd2f0427e62c234afadf33f87263a51c01ce3e5daa3d41b363077a91ffb
MD5 e6e09b5b73d8948e4545d1c7e394888b
BLAKE2b-256 86b3a772dfde7e2de9d5566bc07f956ea70e2688fbf431883423a315d15c6c21

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: citelang-0.0.17-py3-none-any.whl
  • Upload date:
  • Size: 60.7 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.11

File hashes

Hashes for citelang-0.0.17-py3-none-any.whl
Algorithm Hash digest
SHA256 b33cdabb53d3ed13105c1b0fef73e19957f3e4b10bf68ff98b1bf2d7ccaa3cd8
MD5 02b7aece9e8e1761fa54a39d252f39c0
BLAKE2b-256 2c2f4f8382c75d3cb3379bc7a910cd8cbf8fa0747e414463fd75797a3d0826e1

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