Giter VIP home page Giter VIP logo

connectors-main's Introduction

Alphacast's Open-Source Connectors

This is the main repository from where we manage the work behind Alphacast, a collaboration platform for creating, sharing and monetizing decision-making data and analysis. In the Alphacast's Open-Source Connectors you can find thousands of hours of work of our team and the community.

Our database grows on a daily basis but we will be happy if you want to help us in our endevour.

What is the Alphacast's Open-Source Connectors?

  1. This Connectors are the script behind Alphacast verified datasets. We review and validate the code to confirm that they do what they say they do. The code is then run routinely (hourly, daily, weekly) to keep the data updated on our Certified Datasets.
  2. We have begun the process of opening our Connectors. Explore the repositories to find examples, ideas and inspiration! All the code and data created in this project will be open and free! You can also use the codes in this Connectors to create you own datasets and repos with them.
  3. Anyone can upload, share and monetize their data in Alphacast but please, read the Terms & Conditions. Don't share or upload data that you do not own or that you do not have the right to share.
  4. We support the work of our contributors. Write to [email protected] to learn more about this.

How to contribute

If you want to contribute to this project, please follow these guidelines.

  • The "issues" section is our backlog. It includes the data sources that we have identified and are planning to work on.
  • Issues are labeled by repository, source format and difficulty. Our team have estimated the aproximate work needed to solve a specific issue. It depends on your skills, but to use as a benchmark: Easy should require less than one hour of work, intermediate from one to four, difficult from 4 to 8.
  • The Connectors should do three things
  1. Download the data from the source, parse it, clean it and structure it, preferently on a Pandas DataFrame.
  2. Create and initialize the dataset (only to be run once) in YOUR repository. Once aproved we will move it to an Alphacast Certified Dataset.
  3. Upload the data using the API or the Pyhon Library.

General Guidelines

  1. The script should be written in Python. You can use our python library to interact with the API. See the documentation here or connect directly with the API (Postman Doc)

  2. Use your API_KEY and your repository. use a .env with the variable

from alphacast import Alphacast
from dotenv import dotenv_values
API_KEY = dotenv_values(".env").get("API_KEY")
alphacast = Alphacast(API_KEY)
  1. Create and initialize the dataset and upload the data to confirm that everything works properly!
dataset_name = 'your dataset_name'
dataset = alphacast.datasets.create(dataset_name, your_repo_id)
alphacast.datasets.dataset(dataset['id']).initialize_columns(dateColumnName = 'Date', 
             entitiesColumnNames=['country'], dateFormat= '%Y-%m-%d')

alphacast.datasets.dataset(dataset['id']).upload_data_from_df(df, 
                 deleteMissingFromDB = True, onConflictUpdateDB = True, uploadIndex=False)
  1. To validate that you upload is correct you can do two things:

a. Go to alphacast dataset view and check that the data is there https://www.alphacast.io/datasets/datasetId

b. Check the status of the upload process with:

alphacast.datasets.dataset(datasetId).processes()
alphacast.datasets.dataset(datasetId).process(processId)
  1. Submit you code with a Pull Request refering to the issue either in this Repository or in the destination Repository

connectors-main's People

Contributors

lcohan avatar masaez avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.