Skip to main content

Code for Venezuela python library.

Project description

c4v-py

Solving Venezuela pressing matters one commmit at a time

c4v-py is a library used to address Venezuela's pressing issues using computer and data science. Check the online documentation

Installation

Use pip to install the package:

pip install c4v-py

Usage

TODO

Can you help us? Open a new issue in minutes!

Contributing

The following tools are used in this project:

  • Poetry is used as package manager.
  • Nox is used as automation tool, mainly for testing.
  • Black is the mandatory formatter tool.
  • PyEnv is recommended as a tool to handle multiple python versions in your machine.

The library is intended to be compatible with python ~3.6.9, ~3.7.4 and ~3.8.2. But the primary version to support is ~3.8.2.

The general structure of the project is trying to follow the recommendations in Cookiecutter Data Science. The main difference lies in the source code itself which is not constraint to data science code.

Setup

  1. Install pyenv and select a version, ie: 3.8.2. Once installed run pyenv install 3.8.2
  2. Install poetry in your system
  3. Clone this repo in a desired location git clone https://github.com/code-for-venezuela/c4v-py.git
  4. Navigate to the folder cd c4v-py
  5. Make sure your poetry picks up the right version of python by running pyenv local 3.8.2, if 3.8.2 is your right version.
  6. Since our toml file is already created, we need to get all dependencies by running poetry install. This step might take a few minutes to complete.
  7. Install nox
  8. From c4v-py directory, on your terminal, run the command nox -s tests to make sure all the tests run.

If you were able to follow every step with no error, you are ready to start contributing. Otherwise, open a new issue!

Roadmap

  • Add CONTRIBUTING guidelines
  • Add issue templates
  • Document where to find things (datasets, more info, etc.)
    • This might be done (in conjunction) with Github Projects. Managing tasks there might be a good idea.
  • Add LICENSE
  • Change the authors field in pyproject.toml
  • Change the repository field in pyproject.toml
  • Move the content below to a place near to the data in the data folder or use the reference folder. Check Cookiecutter Data Science for details.
  • Understand what is in the following folders and decide what to do with them.
    • brat-v1.3_Crunchy_Frog
    • creating_models
    • data/data_to_annotate
    • data_analysis
  • Set symbolic links between brat-v1.3_Crunchy_Frog/data and data/data_to_annotate. data_sampler extracts to data/data_to_annotate. Files placed here are read by Brat.
    • Download Brat - wget https://brat.nlplab.org/index.html
    • untar brat - tar -xzvf brat-v1.3_Crunchy_Frog.tar.gz
    • install brat - cd brat-v1.3_Crunchy_Frog && ./install.sh
    • replace default annotation conf for current configuration - wget https://raw.githubusercontent.com/dieko95/c4v-py/master/brat-v1.3_Crunchy_Frog/annotation.conf -O annotation.conf
    • replace default config.py for current configuration - wget https://raw.githubusercontent.com/dieko95/c4v-py/master/brat-v1.3_Crunchy_Frog/config.py -O config.py

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

c4v-py-0.1.0.dev202110126.tar.gz (72.2 kB view details)

Uploaded Source

Built Distribution

c4v_py-0.1.0.dev202110126-py3-none-any.whl (92.1 kB view details)

Uploaded Python 3

File details

Details for the file c4v-py-0.1.0.dev202110126.tar.gz.

File metadata

  • Download URL: c4v-py-0.1.0.dev202110126.tar.gz
  • Upload date:
  • Size: 72.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.8.5 Linux/5.10.60.1-microsoft-standard-WSL2

File hashes

Hashes for c4v-py-0.1.0.dev202110126.tar.gz
Algorithm Hash digest
SHA256 a8234f08ecfb1003a1f0f219e09396f593a4c5ae80612b6c31770d8ecc5c5fe8
MD5 440471233fbead9124edff37b5b52a2a
BLAKE2b-256 bc603ece14b29c4e4f3509d178e89784b1bd70ea1035e1f543e76fd9694f2eff

See more details on using hashes here.

File details

Details for the file c4v_py-0.1.0.dev202110126-py3-none-any.whl.

File metadata

  • Download URL: c4v_py-0.1.0.dev202110126-py3-none-any.whl
  • Upload date:
  • Size: 92.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.8.5 Linux/5.10.60.1-microsoft-standard-WSL2

File hashes

Hashes for c4v_py-0.1.0.dev202110126-py3-none-any.whl
Algorithm Hash digest
SHA256 37788bb3d6bd9917279b3782c42dc42577b6e765aa67a9f0e6ea591adaadfcb2
MD5 0d2365acd8c64423f05d376bb820de20
BLAKE2b-256 f1a9a7f3d96ec9474fd364bc40f9fb4e6a3a980465c24aeb8c15cd12198eb58d

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