dane
Utils for working with the Distributed Annotation 'n' Enrichment (DANE) system
Science Score: 23.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 4 committers (25.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.9%) to scientific vocabulary
Repository
Utils for working with the Distributed Annotation 'n' Enrichment (DANE) system
Basic Info
- Host: GitHub
- Owner: CLARIAH
- License: apache-2.0
- Language: Python
- Default Branch: main
- Homepage: https://dane.readthedocs.io/en/latest/
- Size: 362 KB
Statistics
- Stars: 4
- Watchers: 11
- Forks: 1
- Open Issues: 3
- Releases: 0
Metadata Files
README.md
DANE
The Distributed Annotation 'n' Enrichment (DANE) system handles compute task assignment and file storage for the automatic annotation of content.
This repository contains contains the building blocks for with DANE, such as creating custom analysis workers or submitting new task.
Installation
This package can be installed through pip:
pip install dane
Configuration
DANE components are configured through the dane.config module, which is described here: https://dane.readthedocs.io/en/latest/intro.html#configuration
It is however noteable that, because all DANE components are expected to rely on it, some of the DANE-server, ElasticSearch and RabbitMQ configuration
are included in the default config. As such it is recommended that you create a $HOME/.dane/config.yml or $DANE_HOME/config.yml which contain machine-wide settings for how to connect to these services, which involves specifying the following settings:
DANE:
API_URL: 'http://localhost:5500/DANE/'
MANAGE_URL: 'http://localhost:5500/manage/'
RABBITMQ:
HOST: 'localhost'
PORT: 5672
EXCHANGE: 'DANE-exchange'
RESPONSE_QUEUE: 'DANE-response-queue'
USER: 'guest'
PASSWORD: 'guest'
ELASTICSEARCH:
HOST: ['localhost']
PORT: 9200
USER: 'elastic'
PASSWORD: 'changeme'
SCHEME: 'http'
INDEX: 'your_dane_index'
The values given here are the default values.
Usage
Examples of how to use DANE can be found in the examples/ directory.
Local Development
We moved from setup.py & requirements.txt to a single pyproject.toml. For local builds and publishing we use poetry.
For local installation:
bash
poetry install
poetry shell
After installation the following unit test should succeed:
bash
python -m test.test_dane
To build a wheel + source package (will end up in dist directory):
bash
poetry build
The wheel can be conveniently tested in e.g. your own DANE worker by installing it e.g. using pip:
bash
pip install path_to_dane_wheel_file
or with poetry
bash
poetry add path_to_dane_wheel_file
Breaking changes after 0.3.1
Since version 0.3.1 DANE must be imported in lowercase letters:
python
import dane
Before version 0.3.1 you should import using uppercase letters:
python
import DANE
Owner
- Name: CLARIAH
- Login: CLARIAH
- Kind: organization
- Website: http://www.clariah.nl
- Repositories: 65
- Profile: https://github.com/CLARIAH
CLARIAH offers humanities scholars a Common Lab providing access to large collections of digital resources and innovative tools for research
GitHub Events
Total
Last Year
Committers
Last synced: about 1 year ago
Top Committers
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 5
- Total pull requests: 10
- Average time to close issues: 11 days
- Average time to close pull requests: about 1 month
- Total issue authors: 3
- Total pull request authors: 3
- Average comments per issue: 1.6
- Average comments per pull request: 0.2
- Merged pull requests: 9
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 1
- Average comments per issue: 0.0
- Average comments per pull request: 0.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- Veldhoen (3)
- jblom (1)
- Janwillemtv (1)
Pull Request Authors
- jblom (6)
- Veldhoen (2)
- mwigham (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 1,915 last-month
-
Total dependent packages: 2
(may contain duplicates) -
Total dependent repositories: 3
(may contain duplicates) - Total versions: 38
- Total maintainers: 1
pypi.org: dane
Utils for working with the Distributed Annotation and Enrichment system
- Homepage: https://github.com/CLARIAH/DANE
- Documentation: https://dane.readthedocs.io/
- License: Apache-2.0
-
Latest release: 0.4.3
published about 2 years ago
Rankings
Maintainers (1)
pypi.org: dane-server
Back-end for the Distributed Annotation 'n' Enrichment (DANE) system
- Homepage: https://github.com/CLARIAH/DANE
- Documentation: https://dane-server.readthedocs.io/
- License: Apache-2.0
-
Latest release: 0.3.1
published about 3 years ago
Rankings
Maintainers (1)
Dependencies
- black ^22.8.0 develop
- flake8 ^5.0.4 develop
- mockito ^1.4.0 develop
- mypy ^0.971 develop
- pytest ^7.1.3 develop
- pytest-cov ^3.0.0 develop
- types-requests ^2.28.10 develop
- elasticsearch7 ^7.17.3
- pika ^1.2.1
- python ^3.10
- requests ^2.28.1
- yacs ^0.1.8
- DANE *
- elasticsearch7 *
- pika *