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 ⭐️

TODO

  • citelang should be able to parse requirements.txt or go.sum, etc.
  • add graphic summary
  • finish GitHub actions (render, docs, remember to mention to use token, etc.)
  • add gha to run here!

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

Uploaded Source

Built Distribution

citelang-0.0.13-py3-none-any.whl (57.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: citelang-0.0.13.tar.gz
  • Upload date:
  • Size: 43.4 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.13.tar.gz
Algorithm Hash digest
SHA256 ebee3f1f97be4e31b24d8858a24f9ee26a6b3d0f2b81c389082ce7aae8ae3621
MD5 6ff9fc44ce5f9a4099e2bde12e2c1280
BLAKE2b-256 5d3dcaac87ba82cc9daa3c121299baa2281bafdfb8770ee8162158e29c716f8c

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: citelang-0.0.13-py3-none-any.whl
  • Upload date:
  • Size: 57.1 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.13-py3-none-any.whl
Algorithm Hash digest
SHA256 46c4ef40637761b3fe0250cf8ecd2fe7d1494f7188f92580fcf0cd9dd55a157d
MD5 00af514c8823e9e56a63901bd6bbddfe
BLAKE2b-256 7d1a3733601f8bcb69f6d2760195561975dd41ae8d51e992012be02dd2508677

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