cdp-backend


Namecdp-backend JSON
Version 4.1.2 PyPI version JSON
download
home_page
SummaryData storage utilities and processing pipelines used by CDP instances.
upload_time2023-06-16 23:51:29
maintainer
docs_urlNone
authorTo Huynh, Isaac Na, Council Data Project Contributors
requires_python>=3.8
licenseMIT License
keywords civic technology open government
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # cdp-backend

[![Build Status](https://github.com/CouncilDataProject/cdp-backend/workflows/CI/badge.svg)](https://github.com/CouncilDataProject/cdp-backend/actions)
[![Documentation](https://github.com/CouncilDataProject/cdp-backend/workflows/Documentation/badge.svg)](https://CouncilDataProject.github.io/cdp-backend)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.03904/status.svg)](https://doi.org/10.21105/joss.03904)

Data storage utilities and processing pipelines used by CDP instances.

---

## Council Data Project

Council Data Project is an open-source project dedicated to providing journalists, activists, researchers, and all members of each community we serve with the tools they need to stay informed and hold their Council Members accountable.

For more information about Council Data Project, please visit [our website](https://councildataproject.org/).

## About

`cdp-backend` is used to maintain the database models, infrastructure stack, and all pipelines for CDP Instance web applications.

The central goal is to create a single library that manages the whole backend of any CDP Instance.

## Installation

**Stable Release (with just data access dependencies):** `pip install cdp-backend`<br/>
**Stable Release (with full pipeline dependencies):** `pip install cdp-backend[pipeline]`

**Development Head:** `pip install git+https://github.com/CouncilDataProject/cdp-backend.git`

**Dev Installation:** For devs, please ensure that you have [dot / graphviz](https://graphviz.org/download/) installed before working with tests and auto-documentation generation.

## Infrastructure

Please see [dev-infrastructure](./dev-infrastructure) for defaults on dev deployments.

## Documentation

For full package documentation please visit [councildataproject.org/cdp-backend](https://councildataproject.org/cdp-backend).

## Development

See [CONTRIBUTING.md](CONTRIBUTING.md) for information related to development of this repository.

## Citation

If you have found CDP software, data, or ideas useful in your own work, please consider citing us:

Brown et al., (2021). Council Data Project: Software for Municipal Data Collection, Analysis, and Publication. Journal of Open Source Software, 6(68), 3904, https://doi.org/10.21105/joss.03904

```bibtex
@article{Brown2021,
  doi = {10.21105/joss.03904},
  url = {https://doi.org/10.21105/joss.03904},
  year = {2021},
  publisher = {The Open Journal},
  volume = {6},
  number = {68},
  pages = {3904},
  author = {Eva Maxfield Brown and To Huynh and Isaac Na and Brian Ledbetter and Hawk Ticehurst and Sarah Liu and Emily Gilles and Katlyn M. f. Greene and Sung Cho and Shak Ragoler and Nicholas Weber},
  title = {{Council Data Project: Software for Municipal Data Collection, Analysis, and Publication}},
  journal = {Journal of Open Source Software}
}
```

## License

**MIT License**

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "cdp-backend",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "civic technology,open government",
    "author": "To Huynh, Isaac Na, Council Data Project Contributors",
    "author_email": "Eva Maxfield Brown <evamaxfieldbrown@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/67/a0/d2b5ff82c8ebd3c2f8bc301d9a5c83fc171b5beaa00560cbf0f180c880ae/cdp-backend-4.1.2.tar.gz",
    "platform": null,
    "description": "# cdp-backend\n\n[![Build Status](https://github.com/CouncilDataProject/cdp-backend/workflows/CI/badge.svg)](https://github.com/CouncilDataProject/cdp-backend/actions)\n[![Documentation](https://github.com/CouncilDataProject/cdp-backend/workflows/Documentation/badge.svg)](https://CouncilDataProject.github.io/cdp-backend)\n[![DOI](https://joss.theoj.org/papers/10.21105/joss.03904/status.svg)](https://doi.org/10.21105/joss.03904)\n\nData storage utilities and processing pipelines used by CDP instances.\n\n---\n\n## Council Data Project\n\nCouncil Data Project is an open-source project dedicated to providing journalists, activists, researchers, and all members of each community we serve with the tools they need to stay informed and hold their Council Members accountable.\n\nFor more information about Council Data Project, please visit [our website](https://councildataproject.org/).\n\n## About\n\n`cdp-backend` is used to maintain the database models, infrastructure stack, and all pipelines for CDP Instance web applications.\n\nThe central goal is to create a single library that manages the whole backend of any CDP Instance.\n\n## Installation\n\n**Stable Release (with just data access dependencies):** `pip install cdp-backend`<br/>\n**Stable Release (with full pipeline dependencies):** `pip install cdp-backend[pipeline]`\n\n**Development Head:** `pip install git+https://github.com/CouncilDataProject/cdp-backend.git`\n\n**Dev Installation:** For devs, please ensure that you have [dot / graphviz](https://graphviz.org/download/) installed before working with tests and auto-documentation generation.\n\n## Infrastructure\n\nPlease see [dev-infrastructure](./dev-infrastructure) for defaults on dev deployments.\n\n## Documentation\n\nFor full package documentation please visit [councildataproject.org/cdp-backend](https://councildataproject.org/cdp-backend).\n\n## Development\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for information related to development of this repository.\n\n## Citation\n\nIf you have found CDP software, data, or ideas useful in your own work, please consider citing us:\n\nBrown et al., (2021). Council Data Project: Software for Municipal Data Collection, Analysis, and Publication. Journal of Open Source Software, 6(68), 3904, https://doi.org/10.21105/joss.03904\n\n```bibtex\n@article{Brown2021,\n  doi = {10.21105/joss.03904},\n  url = {https://doi.org/10.21105/joss.03904},\n  year = {2021},\n  publisher = {The Open Journal},\n  volume = {6},\n  number = {68},\n  pages = {3904},\n  author = {Eva Maxfield Brown and To Huynh and Isaac Na and Brian Ledbetter and Hawk Ticehurst and Sarah Liu and Emily Gilles and Katlyn M. f. Greene and Sung Cho and Shak Ragoler and Nicholas Weber},\n  title = {{Council Data Project: Software for Municipal Data Collection, Analysis, and Publication}},\n  journal = {Journal of Open Source Software}\n}\n```\n\n## License\n\n**MIT License**\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Data storage utilities and processing pipelines used by CDP instances.",
    "version": "4.1.2",
    "project_urls": {
        "Bug Tracker": "https://github.com/CouncilDataProject/cdp-backend/issues",
        "Documentation": "https://CouncilDataProject.github.io/cdp-backend",
        "Homepage": "https://github.com/CouncilDataProject/cdp-backend",
        "User Support": "https://github.com/CouncilDataProject/cdp-backend/issues"
    },
    "split_keywords": [
        "civic technology",
        "open government"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "38434d662d24099a0ceb1d40fa43cb31157cb06b816239d93c0b3218402971f0",
                "md5": "192bc1932bd02dd926cc6e95a9e57202",
                "sha256": "dc4002fcc1f63314292b7aa537e1d8414f0940de093e52c99a74662297e9b4a5"
            },
            "downloads": -1,
            "filename": "cdp_backend-4.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "192bc1932bd02dd926cc6e95a9e57202",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 51095408,
            "upload_time": "2023-06-16T23:51:24",
            "upload_time_iso_8601": "2023-06-16T23:51:24.217544Z",
            "url": "https://files.pythonhosted.org/packages/38/43/4d662d24099a0ceb1d40fa43cb31157cb06b816239d93c0b3218402971f0/cdp_backend-4.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "67a0d2b5ff82c8ebd3c2f8bc301d9a5c83fc171b5beaa00560cbf0f180c880ae",
                "md5": "4b4ae886d561a94c3b14699233e900d2",
                "sha256": "ee254156851568f4ca9ab3a588a773db165e87ea444b709290c47581c67a6041"
            },
            "downloads": -1,
            "filename": "cdp-backend-4.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "4b4ae886d561a94c3b14699233e900d2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 51066396,
            "upload_time": "2023-06-16T23:51:29",
            "upload_time_iso_8601": "2023-06-16T23:51:29.601153Z",
            "url": "https://files.pythonhosted.org/packages/67/a0/d2b5ff82c8ebd3c2f8bc301d9a5c83fc171b5beaa00560cbf0f180c880ae/cdp-backend-4.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-16 23:51:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "CouncilDataProject",
    "github_project": "cdp-backend",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "cdp-backend"
}
        
Elapsed time: 0.10060s