eriknovak / datachart

Data visualization package, simple to use, highly customizable

Data visualization package, simple to use, highly customizable

---

Documentation: https://eriknovak.github.io/datachart

Source code: https://github.com/eriknovak/datachart

---

The datachart package is a python package for creating data visualizations. It is designed to be simple to use and highly customizable, i.e. it is easy to change the look and feel of the charts.

✅ Requirements

Before starting the project make sure these requirements are available:

• python. The python programming language (v3.8 or higher).

Install

pip install datachart

Example

TODO

datachart's Issues

Add charts documentation

Add the documentation for all three charts:

• #6
• #7
• #8

Add API Reference

Describe the missing documentation

Provide an API reference documentation for each component of the datachart package. It should also contain examples of how to use them.

Automatic deployment on release

Connected to a problem?

Provide an automatic deployment process when the package gets a version increase.

Solution?

Utilize Github Actions to deploy the package to PyPI using the version of the github package. In addition, project configuration will have to take the appropriate version from github and override the one written in the pyproject.toml file.

Alternatives?

No response

Add histogram chart documentation

Add the documentation for the line chart. For it, provide:

1. A documentation of the whole input parameters
2. Step-by-step examples of how to go from more simple charts to more advanced and complex
3. A couple of use-cases for the chart object

Add documentation to the website

Describe the missing documentation

Add the documentation for the following pages:

• #5

  • #6
  • #7
  • #8

• #9

• #10

For each page provide code examples (with images of the generation graph). Develop it using Material for MkDocs.

Add line chart documentation

Add the documentation for the line chart. For it, provide:

1. A documentation of the whole input parameters
2. Step-by-step examples of how to go from more simple charts to more advanced and complex
3. A couple of use-cases for the chart object

Add pyramid chart

Connected to a problem?

When comparing two categorical values, a simple barchart might not be as effective to showcase the message. For example, the gender distribution across age groups should clearly show also the distribution of each gender across age groups.

Solution?

Implement a pyramid chart, which can be used for visualizing population pyramids.

Alternatives?

No response

Add constants documentation

Add the constants documentation to the website.

For each constant provide:

• A description of the constant
• An example of how to load it
• The differences between the constant values

Add bar chart documentation

Add the documentation for the line chart. For it, provide:

1. A documentation of the whole input parameters
2. Step-by-step examples of how to go from more simple charts to more advanced and complex
3. A couple of use-cases for the chart object

Add configuration documentation

Add documentation for the config object. This includes:

1. It’s default values and their options + where the values are used (which chart and which chart element)
2. How to update the config attributes
3. How to reset the config attributes