Welcome to dalia’s documentation!

Contents:

dalia

https://img.shields.io/pypi/v/dalia.svg https://img.shields.io/travis/brews/dalia.svg Documentation Status

This code is under heavy development. Don’t use it.

Features

  • Read CSVV files with dalia.read_csvv().
  • Read regional hierarchy files as a tree with dalia.read_hierarchy().

Installation

To install with pip:

pip install dalia

Installation

Stable release

To install dalia, run this command in your terminal:

$ pip install dalia

This is the preferred method to install dalia, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for dalia can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/brews/dalia

Or download the tarball:

$ curl  -OL https://github.com/brews/dalia/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

User Guide

To use dalia in a project:

import dalia

IO

To read CSVV files, use read_csvv(). Afraid that’s all we got right now.

API reference

This page provides an auto-generated summary of dalia’s API.

read_csvv(filepath_or_buffer[, sep]) Read a CSVV file into a CSVV object
csvv.Csvv(oneline, version, dependencies, …) Data from a CSVV file

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/brews/dalia/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

dalia could always use more documentation, whether as part of the official dalia docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/brews/dalia/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up dalia for local development.

  1. Fork the dalia repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/dalia.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv dalia
$ cd dalia/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 dalia
$ pytest

    To get flake8, just pip install them into your environment.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/brews/dalia/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ pytest dalia.tests.test_io

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.3.0 (2019-12-25)

  • read_hierarchy() now explicitly sets each entry from the “name” column to the “namelong” attribute and the “name” attribute is the region key. In past versions, these metadata would clobber important node attribute names.

0.2.2 (2019-12-25)

  • Patch minor additional issues package version metadata.

0.2.1 (2019-12-25)

  • Patch minor issue with deployment and package version metadata.

0.2.0 (2019-12-25)

  • Add read_hierarchy() to read regional hierarchy CSV files.

0.1.2a2 (2019-10-31)

  • Add read_csvv() and dalia.csvv.Csvv to read and represent CSVV files.
  • Initial documentation.

0.0.1a1 (2019-10-10)

  • First release on PyPI.

Indices and tables