https://github.com/acdh-oeaw/acdh-django-zotero

A django package to store/process zotero items

https://github.com/acdh-oeaw/acdh-django-zotero

Science Score: 10.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    2 of 3 committers (66.7%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.8%) to scientific vocabulary

Keywords

acdh-django-packages django

Keywords from Contributors

interactive projection archival sequences observability autograding hacking shellcodes modular network-simulation
Last synced: 6 months ago · JSON representation

Repository

A django package to store/process zotero items

Basic Info
  • Host: GitHub
  • Owner: acdh-oeaw
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 35.2 KB
Statistics
  • Stars: 2
  • Watchers: 6
  • Forks: 2
  • Open Issues: 1
  • Releases: 0
Topics
acdh-django-packages django
Created over 7 years ago · Last pushed about 3 years ago
Metadata Files
Readme Changelog Contributing License

README.rst

=============================
acdh-django-zotero
=============================

.. image:: https://badge.fury.io/py/acdh-django-zotero.svg
    :target: https://badge.fury.io/py/acdh-django-zotero


A django package to store/process zotero items

Documentation
-------------



Quickstart
----------

Install acdh-django-zotero::

    pip install acdh-django-zotero

Add it to your `INSTALLED_APPS`:

.. code-block:: python

    INSTALLED_APPS = (
        ...
        'bib',
        ...
    )

Add following Zotero settings to you settings-file:

    .. code-block:: python

        Z_ID = "{a valid zotero API user ID}"
        Z_LIBRARY_TYPE = 'group' # or 'user'
        Z_API_KEY = "{a valid Zotero API user key}"
        Z_NN = {placeholder if no kind of creator is set, defaults to 'N.N.'}

See [pyzotero](http://pyzotero.readthedocs.io/en/latest/) for more information

Add acdh-django-zotero's URL patterns:

.. code-block:: python

    from rest_framework import routers

    ...
    from bib import urls as bib_urls
    from bib.api_views import ZotItemViewSet
    ...

    ...
    router = routers.DefaultRouter()
    router.register(r'zotitems', ZotItemViewSet)
    ...

    urlpatterns = [
        ...
        url(r'^bib/', include('bib.urls', namespace='bib')),
        ...
    ]

And run `python manage.py migrate`

Features
--------

* `bib` app registers a `ZotItem?  class which stores (some) information taken from a full zotero item entry. It provides then autocomplete functions for those ZotItem objects.
* The app also provides `management` commands to import items from a zotero library as well as to update existing items.

    `python manage.py bib_import --limit=15` # imports the top 15 items
    `python manage.py bib_import --since=100` # imports all items from library version 100
    `python manage.py bib_import` # import everything

    `python manage.py bib_update` # imports all items with a higher version number then the highest version number of the items stored in your db.

* The latter function can also be triggered through the front end by browsing to `{root}/bib/synczotero`

Build and publish
-----

.. code-block:: console

    python setup.py sdist bdist_wheel
    twine upload dist/*

Credits
-------

Tools used in rendering this package:

*  Cookiecutter_
*  `cookiecutter-djangopackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage

Owner

  • Name: Austrian Centre for Digital Humanities & Cultural Heritage
  • Login: acdh-oeaw
  • Kind: organization
  • Email: acdh@oeaw.ac.at
  • Location: Vienna, Austria

GitHub Events

Total
  • Fork event: 1
Last Year
  • Fork event: 1

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 15
  • Total Committers: 3
  • Avg Commits per committer: 5.0
  • Development Distribution Score (DDS): 0.333
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
csae8092 p****r@o****t 10
Peter Andorfer P****r@o****t 4
dependabot[bot] 4****] 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 7
  • Total pull requests: 1
  • Average time to close issues: 6 months
  • Average time to close pull requests: about 16 hours
  • Total issue authors: 3
  • Total pull request authors: 1
  • Average comments per issue: 0.71
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • csae8092 (4)
  • openHBP (2)
  • jhrdt (1)
Pull Request Authors
  • dependabot[bot] (1)
Top Labels
Issue Labels
enhancement (1) bug (1)
Pull Request Labels
dependencies (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 111 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 7
  • Total maintainers: 2
pypi.org: acdh-django-zotero

A django package to store and process zotero items

  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 111 Last month
Rankings
Dependent packages count: 10.1%
Downloads: 19.1%
Average: 20.3%
Dependent repos count: 21.6%
Forks count: 22.7%
Stargazers count: 27.9%
Maintainers (2)
Last synced: 6 months ago

Dependencies

requirements_dev.txt pypi
  • bumpversion ==0.5.3 development
  • wheel ==0.30.0 development
requirements_test.txt pypi
  • codecov >=2.0.0 test
  • coverage ==4.4.1 test
  • flake8 >=2.1.0 test
  • mock >=1.0.1 test
  • tox >=1.7.0 test
setup.py pypi
  • django-autocomplete-light *
  • djangorestframework *
  • pyzotero *