Metadata-Version: 2.1
Name: viltolyckor-scraper
Version: 0.2.0
Summary: A scraper of statistical data from viltolyckor.se, built on top of Statscraper.
Home-page: https://github.com/jplusplus/viltolyckor_scraper
Author: Jens Finnäs
Author-email: jens.finnas@gmail.com
License: MIT
Download-URL: https://github.com/jplusplus/viltolyckor_scraper/archive/0.2.0.tar.gz
Platform: UNKNOWN
Requires-Dist: beautifulsoup4
Requires-Dist: lxml
Requires-Dist: requests
Requires-Dist: statscraper


This is a scraper for statistical data from the (https://www.viltolycka.se/statistik/viltolyckor-for-respektive-viltslag/)[viltolycka.se]  built on top of the `Statscraper package <https://github.com/jplusplus/statscraper>`.

The scraper is limited to the data avialble through https://www.viltolycka.se/statistik/viltolyckor-for-respektive-viltslag/

Install
-------

.. code:: bash

  $ pip install viltolyckor_scraper


Example usage
-------------

.. code:: python

  from viltolyckor import ViltolyckorScraper

  # Init scraper
  scraper = ViltolyckorScraper()

  # List all available datasets
  datasets = scraper.items
  # [<ViltolyckorDataset: viltolyckor per viltslag>]

  # Select a dataset
  dataset = scraper.items["viltolyckor per viltslag"]

  # List all available dimensions
  datasets = verksamhetsform.dimensions
  # [<Dimension: region>, <Dimension: year>, <Dimension: month>, <Dimension: viltslag>]

  # Make a query
  res = dataset.fetch()  # Get latest available data for whole country by default

  # Analyze the results with Pandas
  df = res.pandas

  # Make a more specific query
  # Get data for a given period
  res = dataset.fetch({"period": "2015"})

  # Or from a specific region (all years)
  res = ds.fetch({"region": u"Stockholms län", "year": "*"})


Develop
-------

Set up:

.. code:: bash

  $ pip install -r requirements.txt

Run tests:

.. code:: bash

  $ make tests


Deployment
----------

To deploy a new version to PyPi:

1. Update version in `setup.py`
2. Build: `python3 setup.py sdist bdist_wheel`
3. Upload: `python3 -m twine upload dist/viltolyckor_scraper-X.Y.X*`

...assuming you have Twine installed (`pip install twine`) and configured.


