Skip to main content

A KITOpen wrapper for python

Project description

pykitopen

https://img.shields.io/pypi/v/pykitopen.svg Documentation Status

A python wrapper for the KITOpen database!

Getting Started

Installation

The package is best installed using pip, as it will also install all the necessary dependencies

$ pip install pykitopen

Usage

To query the KITOpen search function, simply create a KitOpen wrapper object with the desired configuration and call the search function with the relevant parameters. The returned SearchResults object can be iterated for all the publications.

from pykitopen import KitOpen, Publication
from pykitopen.config import DEFAULT

kitopen = KitOpen(DEFAULT)
results = kitopen.search({
    'author':       'MUSTERMANN, MAX',
    'start':        '2012',
    'stop':         '2016',
    'view':         Publication.VIEWS.FULL
})

for publication in results:
    print(publication.data)

Features

The library is still under development, which is why this first version only provides some basic functionality. At the moment only a publication search is supported:

  • Searching by author and by year

  • Customizable publication “views”, which define the fields to be included.

Planned

  • Support more search parameters such as publication type, open access availability etc.

  • Add support for the metrics generation feature of KITOpen.

  • Add additional batching strategies

  • Add export of the result to different formats such as CSV, JSON…

License

Distributed under the MIT License. See LICENSE for more information

Contact

Jonas Teufel - jonseb1998@gmail.com

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.0 (17.06.2020)

  • Initial release

0.1.1 (23.01.2021)

  • changed datetime format in HISTORY.rst

  • fixed error

  • Added VERSION file

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

pykitopen-0.1.1.tar.gz (20.8 kB view details)

Uploaded Source

Built Distribution

pykitopen-0.1.1-py2.py3-none-any.whl (14.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: pykitopen-0.1.1.tar.gz
  • Upload date:
  • Size: 20.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.25.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for pykitopen-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3d201c20d52a3b30c1e49a180ea76cb564a13095441ed64770a9b65c2df2f2fc
MD5 16df11239604bc82118d25504112518b
BLAKE2b-256 b37f9ef921f3b90c9cce76dfa172e1f33d2ef47c16585f6b87d4b451f2dc3036

See more details on using hashes here.

File details

Details for the file pykitopen-0.1.1-py2.py3-none-any.whl.

File metadata

  • Download URL: pykitopen-0.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 14.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.25.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for pykitopen-0.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a6bbb20c4e408361a665cdc3873420928aa9824315003c7e23ab4e4617612a50
MD5 cef55f34091baae2deb26c0e6d1c67fb
BLAKE2b-256 2670076c44f24f72305a130d507d62977dd67956a3b6c6ece8a3ad2277393815

See more details on using hashes here.

Supported by

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