Skip to content

technologiestiftung/innovationsdaten

Repository files navigation

All Contributors

Innovationsdaten

Prerequisites

  • Latest Python 3.11 version (i.e. 3.11.4, other versions might work as well) – You can e.g. use pyenv, see below.

Installation

Set your virtual environment

The following steps are not required but recommended. This will allow you to install packages in your isolated virtual environment instead of globally, reducing the risk of breaking system tools or other projects.

  1. Install pyenv and the pyenv-virtualenv plugin.
  2. Download the appropriate Python version with
pyenv install 3.11.4

in the command line. 3. Create a virtual environment with the appropriate Python version and name for your environment, for example

pyenv virtualenv 3.11.4 innovationserhebung
  1. Activate the environment with
pyenv activate innovationserhebung

Install Python requirements and pre-commit

Install the required libraries with the command line

pip install -r requirements.txt -r requirements-dev.txt

Install the pre-commit git hook

pre-commit install

Usage or Deployment

Convert the source XLSX data source to JSON

Taking an input XLSX file similar to the one in this repository, you can convert it to JSON by running

python -m data_processing.xlsx2json

Handling & updating requirements

We are using pip-tools to handle the requirements and keep the dependencies updated.

In case you are updating or adding some dependencies, do so in the requirements.*.in files and don't forget to compile the new requirements.*.txt files running:

pip-compile requirements.in
pip-compile requirements-dev.in

To update the packages, following the version pinning defined in the requirements*.in files, run:

pip-compile --upgrade requirements.in
pip-compile --upgrade requirements-dev.in

To keep your environment in sync, run:

pip-sync requirements.txt requirements-dev.txt

Development

tbd...

Tests

tbd...

Contributing

Before you create a pull request, write an issue so we can discuss your changes.

Contributors

Thanks goes to these wonderful people (emoji key):

Guadalupe Romero
Guadalupe Romero

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Content Licensing

Texts and content available as CC-BY-SA.

Credits

Made by

Supported by

Related Projects

About

Visualizing 10 years of data about innovation in Berlin and Germany

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages