Skip to content
This repository has been archived by the owner on Nov 17, 2022. It is now read-only.

Increase Codelist compatibility with Codelist API formats #298

Open
1 of 34 tasks
hayfield opened this issue Mar 19, 2018 · 0 comments
Open
1 of 34 tasks

Increase Codelist compatibility with Codelist API formats #298

hayfield opened this issue Mar 19, 2018 · 0 comments
Labels
api Changes to the pyIATI API. codelists Relating to IATI Codelists. enhancement Some sort of new functionality (rather than fixing or tweaking something that already existed).

Comments

@hayfield
Copy link
Contributor

hayfield commented Mar 19, 2018

There exists a Codelist API defining multiple formats that a Codelist may exist in. This includes: XML, JSON, CSV. There are also 3 different versions of the Codelist API: 1, 2, 3. Between these numerical versions, there are differences in how one or more of the formats structures information.

pyIATI is currently able to read in CLv3 XML Codelists, and not able to output in any format.


If full historical support is desired, pyIATI should be able to both read and write Codelists of each format.

It may be deemed that certain cases existed historically and should be deemed out-of-scope for pyIATI to support. This decision would need making on a case-by-case basis as deemed appropriate.

  • General
    • Determine how to best handle reading in data that may be in one of many formats
    • Consider supporting Codelist Schemas as a type of Schema in pyIATI
    • Define clean API for outputting in desired formats
  • CLv1
    • XML
      • Read
      • Write
    • JSON
      • Read
      • Write
    • CSV
      • Read
      • Write
  • CLv2
    • XML
      • Read
      • Write
    • JSON
      • Read
      • Write
    • CSV
      • Read
      • Write
  • CLv3
    • XML
      • Read
      • Write
    • JSON
      • Read
      • Write
    • CSV
      • Read
      • Write
@hayfield hayfield added codelists Relating to IATI Codelists. api Changes to the pyIATI API. enhancement Some sort of new functionality (rather than fixing or tweaking something that already existed). labels Mar 19, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api Changes to the pyIATI API. codelists Relating to IATI Codelists. enhancement Some sort of new functionality (rather than fixing or tweaking something that already existed).
Projects
None yet
Development

No branches or pull requests

1 participant