| Name | seano-cli JSON |
| Version |
2.0.0
JSON |
| download |
| home_page | None |
| Summary | The seano command-line interface |
| upload_time | 2024-11-22 02:50:16 |
| maintainer | None |
| docs_url | None |
| author | Andrew Keller |
| requires_python | None |
| license | BSD 3-clause |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Seano
=====
Seano *(a sea of notes)* is a primitive, lightweight database that automatically
associates records with the Git tags where the records where first created.
Records in a Seano database are Json objects, which are stored on disk as
distinct YAML files to improve human-readability. The primary key of the
records is an arbitrary string, which is encoded into the filename of the YAML
file, and is colloquially referred to as the "note ID". Note IDs are random hex
strings by default, but under the hood, they can be pretty much any
filesystem-safe string.
Seano is heavily inspired by [`reno`, written by Doug Hellmann at
OpenStack](https://docs.openstack.org/reno/), and bears a number of similarities
to it. The main difference is that Seano is designed more for general-purpose
*(though, still lightweight)* storage, and concomitantly, is engineered to more
easily coexist with third party data formatters.
Testing Locally
---------------
Starting from scratch, this is how to set up local unit testing:
```sh
# Create and enter a virtual environment:
virtualenv .venv
. .venv/bin/activate
# Install Seano in the virtual environment in "editable mode"
pip install -e .
# Install extra dependencies needed by the unit tests:
pip install -r ci_utest_requirements.txt
```
Then, going forward, you can run unit tests like this:
```sh
pytest
```
Copyright 2024 Andrew Keller
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Raw data
{
"_id": null,
"home_page": null,
"name": "seano-cli",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Andrew Keller",
"author_email": "andrew@kellerfarm.com",
"download_url": "https://files.pythonhosted.org/packages/40/33/4d1a494858ea63481573ab3941450f1e247ee6d60af66848136319570fab/seano_cli-2.0.0.tar.gz",
"platform": null,
"description": "Seano\n=====\n\nSeano *(a sea of notes)* is a primitive, lightweight database that automatically\nassociates records with the Git tags where the records where first created.\n\nRecords in a Seano database are Json objects, which are stored on disk as\ndistinct YAML files to improve human-readability. The primary key of the\nrecords is an arbitrary string, which is encoded into the filename of the YAML\nfile, and is colloquially referred to as the \"note ID\". Note IDs are random hex\nstrings by default, but under the hood, they can be pretty much any\nfilesystem-safe string.\n\nSeano is heavily inspired by [`reno`, written by Doug Hellmann at\nOpenStack](https://docs.openstack.org/reno/), and bears a number of similarities\nto it. The main difference is that Seano is designed more for general-purpose\n*(though, still lightweight)* storage, and concomitantly, is engineered to more\neasily coexist with third party data formatters.\n\nTesting Locally\n---------------\n\nStarting from scratch, this is how to set up local unit testing:\n\n```sh\n# Create and enter a virtual environment:\nvirtualenv .venv\n. .venv/bin/activate\n\n# Install Seano in the virtual environment in \"editable mode\"\npip install -e .\n\n# Install extra dependencies needed by the unit tests:\npip install -r ci_utest_requirements.txt\n```\n\nThen, going forward, you can run unit tests like this:\n\n```sh\npytest\n```\n\nCopyright 2024 Andrew Keller\n\nRedistribution and use in source and binary forms, with or without modification,\nare permitted provided that the following conditions are met:\n\n1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n\n2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\n3. Neither the name of the copyright holder nor the names of its contributors\n may be used to endorse or promote products derived from this software without\n specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND\nANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\nWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR\nANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\nLOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON\nANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n",
"bugtrack_url": null,
"license": "BSD 3-clause",
"summary": "The seano command-line interface",
"version": "2.0.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "40334d1a494858ea63481573ab3941450f1e247ee6d60af66848136319570fab",
"md5": "169bfd5666adb61bc6951f6e0f0b4426",
"sha256": "0cc02ad7bab6093be02c933860eb1fabc5c51063ab8ad4183acc846dd35886ba"
},
"downloads": -1,
"filename": "seano_cli-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "169bfd5666adb61bc6951f6e0f0b4426",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 40707,
"upload_time": "2024-11-22T02:50:16",
"upload_time_iso_8601": "2024-11-22T02:50:16.035229Z",
"url": "https://files.pythonhosted.org/packages/40/33/4d1a494858ea63481573ab3941450f1e247ee6d60af66848136319570fab/seano_cli-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-22 02:50:16",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "seano-cli"
}
