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.0.tar.gz (81.3 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.0-py3-none-any.whl (90.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for datalad_core-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f33643efbb820fe83fc19b7678849532f2ad8583b95bcfff9e116391325696c7
MD5 26e6dcd276822c33da0af74dbfc2a7f8
BLAKE2b-256 60069d83070c0e1582921585a83d1d9e543285ed32c2bdbe69279667467b09f0

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for datalad_core-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7b2748603942c8dc16513c36e88651d2f8994a0633a64cdd669adb94dde48166
MD5 f4a9bfe856c1168becfcc87da0417159
BLAKE2b-256 cc93ce7bf309fbfe16e28f75469bb96b6474dee44629faee9c43910b47d2c2b6

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