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.1.tar.gz (82.4 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.1-py3-none-any.whl (91.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: datalad_core-0.1.1.tar.gz
  • Upload date:
  • Size: 82.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.13

File hashes

Hashes for datalad_core-0.1.1.tar.gz
Algorithm Hash digest
SHA256 b6ca500d6fb7f5efee6a4f2f8b7b961f063414b8c392080063a83f3d7448f656
MD5 4514996d84638711bbd352c499a92e4e
BLAKE2b-256 f27a3c108fecf3951ab4a2b312f5512da44a220dede6318d5a9c36cb3f6405a2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for datalad_core-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b8d7beae889365c0a2eacde0922ab8f4d6e627dbec5a362cb2f581a19b5ec01a
MD5 174b90d6f181b635f9070551ff234b8b
BLAKE2b-256 5e1b23c75505522608d026e3c4022a4c780f93809ef977d78b5db8f77f404b13

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