Metadata-Version: 2.1
Name: wostools
Version: 1.0.0
Summary: Translates isi web of knowledge files into python objects.
Home-page: https://github.com/coreofscience/python-wostools
Author: Core of Science
Author-email: dev@coreofscience.com
License: MIT license
Keywords: wostools
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: Click (>=7.0)

================
Python WoS tools
================


.. image:: https://pyup.io/repos/github/coreofscience/python-wostools/shield.svg
     :target: https://pyup.io/repos/github/coreofscience/python-wostools/
     :alt: Updates

.. image:: https://img.shields.io/pypi/v/wostools.svg
    :target: https://pypi.python.org/pypi/wostools

.. image:: https://img.shields.io/travis/coreofscience/python-wostools.svg
    :target: https://travis-ci.org/coreofscience/python-wostools

.. image:: https://readthedocs.org/projects/python-wostools/badge/?version=latest
    :target: https://python-wostools.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://zenodo.org/badge/94160457.svg
   :target: https://zenodo.org/badge/latestdoi/94160457
   :alt: DOI: 10.5281/zenodo.1344261

Translates ISI Web of Knowledge files into python objects.



* Free software: MIT license
* Documentation: https://python-wostools.readthedocs.io.


Quickstart
----------

Install the library by:

.. code-block:: bash

   $ pip install wostools

Say you want to grab the title of all the articles in an ISI file, you can grab
`this example file`_.

.. code-block:: python

   >>> from wostools import CollectionLazy
   >>> collection = CollectionLazy.from_filenames('docs/examples/bit-pattern-savedrecs.txt')
   >>> for article in collection.articles:
   ...     print(article.TI)
   In situ grazing incidence small-angle X-ray scattering study of solvent vapor annealing in lamellae-forming block copolymer thin films: Trade-off of defects in deswelling
   Structural control of ultra-fine CoPt nanodot arrays via electrodeposition process
   Porphyrin-based Pt/Pd-containing metallopolymers: Synthesis, characterization, optical property and potential application in bioimaging
   Syntheses and Controllable Self-Assembly of Luminescence Platinum(II) Plane-Coil Diblock Copolymers
   # ...

Never fear wostools cli is here. To help you do some common tasks right from
your terminal.

.. code-block:: bash

   $ wostools --help
   $ # To extract all the properties in a json file
   $ wostools to-json docs/examples/bit-pattern-savedrecs.txt --output=document.json

Features
--------

* Just parses an ISI Web of Knowledge file and produces a native python object.
* Through the :code:`CollectionLazy` object it can do this using the minimum
  amount of memory it can possibly do.
* It has a cli to extract documents and citation pairs for you :smile:

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
.. _`this example file`: docs/examples/bit-pattern-savedrecs.txt


=======
History
=======

0.2.0 (2018-08-12)
------------------

* Add support for all WOS fields.
* Add graph building support.
* Add a little cli for common tasks.

0.1.1 (2018-05-10)
------------------

* First release on PyPI.


