Giter Club home page Giter Club logo

datapackage-r's People

Contributors

cbratsas avatar kleanthisk10 avatar larjohn avatar pwalsh avatar roll avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Forkers

lwinfree

datapackage-r's Issues

to do

  • read and validate a data package descriptor, including profile-specific validation via the registry of JSON Schemas
  • create and edit a data package descriptor, including methods to add and remove resources and validation after editing
  • provide an API to interact with a data package descriptor
  • streaming and reading of resources through a table schema with cast on iteration
  • save a data package descriptor to a file path
  • save a data package as a zip file on disc
  • read a zip file containing a data package
  • cover the latest changes in the specs such as string/array for path etc
  • support for schema dereferencing before validation
  • support for multipart resources
  • support for csv dialects

Getting started

Description

This issue documents the initial steps to get started with a new Frictionless Data implementation.

Tasks

  • Travis configuration
  • Coveralls configuration
  • Basic setup of README with badges
  • Basic setup of license
  • Review the whole family of specifications
  • Review the implementation notes
  • Review either the Python (Data Package Table Schema) or JavaScript (Data Package Table Schema) reference implementations (whichever language you feel most comfortable reading)
    • Note that we have high nineties test coverage on these libraries. Similar test coverage is expected here
  • Review the stack reference
  • Review the blog post that announces v1 of the specifications
  • Review the test packages that can be used to test your work (in addition to the normal and expected unit tests)
  • Review the OKFN Coding Standards
    • Parts of the coding standard are language specific, and parts are workflow specific. The workflow points are important for you. If you want to contribute language-related standards to our docs for your language, we welcome it!
  • Write a set of high-level issues for each library, on the respective issue tracker, that outline the work plan
    • Note the structure of this issue: A narrative description and a specific list of tasks. Follow a similar pattern
    • The sequence of work is important: start with the Table Schema library first, as the Data Package library has a direct dependency on it
  • Note the communication protocol for this work: All communication around the implementation must be in public. We want our work dynamic here to serve as an example for other implementors, and to share as much information as possible. There are two channels of communication:
  • Note the staff from OKI who are here to support you:
    • Jo Barratt - Project Manager for Frictionless Data
    • Evgeny Karev - Tech Lead for core Frictionless Data libraries
    • Serah Rono - Developer Advocate at Open Knowledge International, Dissemination Lead for the Tool Fund
    • Dan Fowler - Developer Advocate at Open Knowledge International, Pilot Lead for Frictionless Data, OKI Labs Lead
    • Adam Kariv - Engineering Lead at Open Knowledge International, Tech Lead on OpenSpending
    • Paul Walsh - Chief Product Officer at Open Knowledge International

Finishing up

Description

This issue describes the set of tasks to complete in order to finish up work on the library.

Tasks

  • Touch base with the @jobarratt and @pwalsh to notify that you consider the work complete
  • Provide a short description / link to code for how each action is implemented, with a link to unit tests that prove each action
  • Tag your candidate code as v0.1
  • Setup travis to auto deploy tagged versions to the package management solution for your language
  • Ensure that the OKI account on the package management platform is an administrator/maintainer of the package, along with yourself
  • Receive code review from @pwalsh and address any remaining issues
  • Publish final version

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.