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

Uploaded Source

Built Distribution

citelang-0.0.29-py3-none-any.whl (89.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for citelang-0.0.29.tar.gz
Algorithm Hash digest
SHA256 ab67924e3b8f5783072a0577abe9dd39be71b93e26da92c492db82bea6e01c8e
MD5 0c1979c71452f52c481ad813a7309bee
BLAKE2b-256 7253874d3dba5ce15bcdada61ddefc13e60447ddc17c4dc7d9b562331e09f833

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: citelang-0.0.29-py3-none-any.whl
  • Upload date:
  • Size: 89.0 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.29-py3-none-any.whl
Algorithm Hash digest
SHA256 f56fd7bf0513b6ce59e0615ab37feac53bf32739a05643c71c9f97347d60cf55
MD5 56f53fb5ee424e9f7f7ad2bb01e69207
BLAKE2b-256 8a64562562a0fab8b573defdf7948f61c1266dd14d47a5a9e35b5dc3df30bca8

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