2025 Python Packaging Survey is now live!  Take the survey now

Credit parser and markdown language for scientific software.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for vsochat from gravatar.com vsochat

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Mozilla Public License 2.0 (MPL 2.0) (LICENSE)
  • Author: Vanessa Sochat
  • Maintainer: Vanessa Sochat
  • Tags credit , software , rseng , research software
Classifiers
Report project as malware

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.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page