Skip to main content

core library for the datalad-framework

Project description

datalad-core: core library for the DataLad framework

Documentation Status Build status codecov Maintainability Hatch project

Developing with datalad_core

API stability is important, just as adequate semantic versioning, and informative changelogs.

Public vs internal API

Anything that can be imported directly from any of the sub-packages in datalad_core is considered to be part of the public API. Changes to this API determine the versioning, and development is done with the aim to keep this API as stable as possible. This includes signatures and return value behavior.

As an example: from datalad_core.abc import xyz imports a part of the public API, but from datalad_core.abc.def import xyz does not.

Use of the internal API

Developers can obviously use parts of the non-public API. However, this should only be done with the understanding that these components may change from one release to another, with no guarantee of transition periods, deprecation warnings, etc.

Developers are advised to never reuse any components with names starting with _ (underscore). Their use should be limited to their individual subpackage.

Contributing

Contributions to this library are welcome! Please see the contributing guidelines for details on scope and style of potential contributions.

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

datalad_core-0.1.2.tar.gz (82.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

datalad_core-0.1.2-py3-none-any.whl (91.3 kB view details)

Uploaded Python 3

File details

Details for the file datalad_core-0.1.2.tar.gz.

File metadata

  • Download URL: datalad_core-0.1.2.tar.gz
  • Upload date:
  • Size: 82.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for datalad_core-0.1.2.tar.gz
Algorithm Hash digest
SHA256 2c066d2f889206063755bab8a1d010bbc92fcf8834a042a248967dda9c317fee
MD5 6cdad6af29760322e3ed257fd83d8ffe
BLAKE2b-256 8d6f6cb107f99cbaa7b40f05dd1f24c05d556eb171af9de8966450c22e682a90

See more details on using hashes here.

File details

Details for the file datalad_core-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: datalad_core-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 91.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for datalad_core-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 19f9fc8750f01ba1c404c1ac2392ac4fe011df4a27151eac1f68f0e0b4652876
MD5 1d07f1234799ba0edf64924f14fcd42a
BLAKE2b-256 be2ee3b687dcf713810a98864b1041ef4684049610d744edf232920b6bf920ca

See more details on using hashes here.

Supported by

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