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

Uploaded Source

Built Distribution

citelang-0.0.16-py3-none-any.whl (60.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: citelang-0.0.16.tar.gz
  • Upload date:
  • Size: 46.1 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.16.tar.gz
Algorithm Hash digest
SHA256 46dc5ef7b2874bc54c7e192723b922f6ec6babef37384eac702f923c61fa407e
MD5 07fdbcc2f8287a29f1fea3d24a1dcba0
BLAKE2b-256 6f94f9e979619ad74ec224e9b9b1d26e53b667429c6e5607ab3da40c730ac15c

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: citelang-0.0.16-py3-none-any.whl
  • Upload date:
  • Size: 60.5 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.16-py3-none-any.whl
Algorithm Hash digest
SHA256 84016396d45372d21e669ec05eb07e1f4cb2d12d3e803eebfd0350b415dc3c82
MD5 d7aebfbd52bd7d1052a330a0e8679d88
BLAKE2b-256 fec557b02f7377a7f937e9ceba95e1730963122e15efa342cc13679ba88236b2

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