| Name | storm JSON |
| Version |
1.0
JSON |
| download |
| home_page | https://storm.canonical.com |
| Summary | Storm is an object-relational mapper (ORM) for Python developed at Canonical. |
| upload_time | 2024-07-16 18:02:28 |
| maintainer | Storm Developers |
| docs_url | None |
| author | Gustavo Niemeyer |
| requires_python | >=3.6 |
| license | LGPL |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Storm is an Object Relational Mapper for Python developed at
Canonical. API docs, a manual, and a tutorial are available from:
https://storm.canonical.com/
Introduction
============
The project was in development for more than a year for use in
Canonical projects such as Launchpad and Landscape before being
released as free software on July 9th, 2007.
Design:
* Clean and lightweight API offers a short learning curve and
long-term maintainability.
* Storm is developed in a test-driven manner. An untested line of
code is considered a bug.
* Storm needs no special class constructors, nor imperative base
classes.
* Storm is well designed (different classes have very clear
boundaries, with small and clean public APIs).
* Designed from day one to work both with thin relational
databases, such as SQLite, and big iron systems like PostgreSQL
and MySQL.
* Storm is easy to debug, since its code is written with a KISS
principle, and thus is easy to understand.
* Designed from day one to work both at the low end, with trivial
small databases, and the high end, with applications accessing
billion row tables and committing to multiple database backends.
* It's very easy to write and support backends for Storm (current
backends have around 100 lines of code).
Features:
* Storm is fast.
* Storm lets you efficiently access and update large datasets by
allowing you to formulate complex queries spanning multiple
tables using Python.
* Storm allows you to fallback to SQL if needed (or if you just
prefer), allowing you to mix "old school" code and ORM code
* Storm handles composed primary keys with ease (no need for
surrogate keys).
* Storm doesn't do schema management, and as a result you're free
to manage the schema as wanted, and creating classes that work
with Storm is clean and simple.
* Storm works very well connecting to several databases and using
the same Python types (or different ones) with all of them.
* Storm can handle obj.attr = <A SQL expression> assignments, when
that's really needed (the expression is executed at INSERT/UPDATE
time).
* Storm handles relationships between objects even before they were
added to a database.
* Storm works well with existing database schemas.
* Storm will flush changes to the database automatically when
needed, so that queries made affect recently modified objects.
License
=======
Copyright (C) 2006-2020 Canonical, Ltd. All contributions must have
copyright assigned to Canonical.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA
On Ubuntu systems, the complete text of the GNU Lesser General
Public Version 2.1 License is in /usr/share/common-licenses/LGPL-2.1
Developing Storm
================
SHORT VERSION: If you are running ubuntu, or probably debian, the
following should work. If not, and for reference, the long version
is below.
$ dev/ubuntu-deps
$ echo "$PWD/** rwk," | sudo tee /etc/apparmor.d/local/usr.sbin.mysqld >/dev/null
$ sudo aa-enforce /usr/sbin/mysqld
$ make develop
$ make check
LONG VERSION:
The following instructions describe the procedure for setting up a
development environment and running the test suite.
Installing dependencies
-----------------------
The following instructions assume that you're using Ubuntu. The same procedure
will probably work without changes on a Debian system and with minimal changes
on a non-Debian-based linux distribution. In order to run the test suite, and
exercise all supported backends, you will need to install MySQL and
PostgreSQL, along with the related Python database drivers:
$ sudo apt-get install \
mysql-server \
postgresql pgbouncer \
build-essential
These will take a few minutes to download.
The Python dependencies for running tests can be installed with apt-get:
$ apt-get install \
python3-fixtures \
python3-pgbouncer \
python3-psycopg2 \
python3-testresources \
python3-timeline \
python3-transaction \
python3-twisted \
python3-zope.component \
python3-zope.security
Alternatively, dependencies can be downloaded as eggs into the current
directory with:
$ make develop
This ensures that all dependencies are available, downloading from
PyPI as appropriate.
Database setup
--------------
Most database setup is done automatically by the test suite. However,
Ubuntu's default MySQL packaging ships an AppArmor profile that prevents it
from writing to a local data directory. To allow the test suite to do this,
you will need to grant it access, which is most easily done by adding a line
such as this to /etc/apparmor.d/local/usr.sbin.mysqld:
/path/to/storm/** rwk,
Then reload the profile:
$ sudo aa-enforce /usr/sbin/mysqld
Running the tests
-----------------
Finally, its time to run the tests! Go into the base directory of
the storm branch you want to test, and run:
$ make check
They'll take a while to run. All tests should pass: failures mean
there's a problem with your environment or a bug in Storm.
Raw data
{
"_id": null,
"home_page": "https://storm.canonical.com",
"name": "storm",
"maintainer": "Storm Developers",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "storm@lists.canonical.com",
"keywords": null,
"author": "Gustavo Niemeyer",
"author_email": "gustavo@niemeyer.net",
"download_url": "https://files.pythonhosted.org/packages/91/fa/55c42c89fc485c2669a0f4bccfd8d768efd7016671c4c19b2b5915057003/storm-1.0.tar.gz",
"platform": null,
"description": "Storm is an Object Relational Mapper for Python developed at\nCanonical. API docs, a manual, and a tutorial are available from:\n\nhttps://storm.canonical.com/\n\n\nIntroduction\n============\n\nThe project was in development for more than a year for use in\nCanonical projects such as Launchpad and Landscape before being\nreleased as free software on July 9th, 2007.\n\nDesign:\n\n * Clean and lightweight API offers a short learning curve and\n long-term maintainability.\n * Storm is developed in a test-driven manner. An untested line of\n code is considered a bug.\n * Storm needs no special class constructors, nor imperative base\n classes.\n * Storm is well designed (different classes have very clear\n boundaries, with small and clean public APIs).\n * Designed from day one to work both with thin relational\n databases, such as SQLite, and big iron systems like PostgreSQL\n and MySQL.\n * Storm is easy to debug, since its code is written with a KISS\n principle, and thus is easy to understand.\n * Designed from day one to work both at the low end, with trivial\n small databases, and the high end, with applications accessing\n billion row tables and committing to multiple database backends.\n * It's very easy to write and support backends for Storm (current\n backends have around 100 lines of code).\n\nFeatures:\n\n * Storm is fast.\n * Storm lets you efficiently access and update large datasets by\n allowing you to formulate complex queries spanning multiple\n tables using Python.\n * Storm allows you to fallback to SQL if needed (or if you just\n prefer), allowing you to mix \"old school\" code and ORM code\n * Storm handles composed primary keys with ease (no need for\n surrogate keys).\n * Storm doesn't do schema management, and as a result you're free\n to manage the schema as wanted, and creating classes that work\n with Storm is clean and simple.\n * Storm works very well connecting to several databases and using\n the same Python types (or different ones) with all of them.\n * Storm can handle obj.attr = <A SQL expression> assignments, when\n that's really needed (the expression is executed at INSERT/UPDATE\n time).\n * Storm handles relationships between objects even before they were\n added to a database.\n * Storm works well with existing database schemas.\n * Storm will flush changes to the database automatically when\n needed, so that queries made affect recently modified objects.\n\n\nLicense\n=======\n\nCopyright (C) 2006-2020 Canonical, Ltd. All contributions must have\ncopyright assigned to Canonical.\n\nThis library is free software; you can redistribute it and/or\nmodify it under the terms of the GNU Lesser General Public\nLicense as published by the Free Software Foundation; either\nversion 2.1 of the License, or (at your option) any later version.\n\nThis library is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\nLesser General Public License for more details.\n\nYou should have received a copy of the GNU Lesser General Public\nLicense along with this library; if not, write to the Free Software\nFoundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA\n02110-1301 USA\n\nOn Ubuntu systems, the complete text of the GNU Lesser General\nPublic Version 2.1 License is in /usr/share/common-licenses/LGPL-2.1\n\n\nDeveloping Storm\n================\n\nSHORT VERSION: If you are running ubuntu, or probably debian, the\nfollowing should work. If not, and for reference, the long version\nis below.\n\n $ dev/ubuntu-deps\n $ echo \"$PWD/** rwk,\" | sudo tee /etc/apparmor.d/local/usr.sbin.mysqld >/dev/null\n $ sudo aa-enforce /usr/sbin/mysqld\n $ make develop\n $ make check\n\nLONG VERSION:\n\nThe following instructions describe the procedure for setting up a\ndevelopment environment and running the test suite.\n\nInstalling dependencies\n-----------------------\n\nThe following instructions assume that you're using Ubuntu. The same procedure\nwill probably work without changes on a Debian system and with minimal changes\non a non-Debian-based linux distribution. In order to run the test suite, and\nexercise all supported backends, you will need to install MySQL and\nPostgreSQL, along with the related Python database drivers:\n\n $ sudo apt-get install \\\n mysql-server \\\n postgresql pgbouncer \\\n build-essential\n\nThese will take a few minutes to download.\n\nThe Python dependencies for running tests can be installed with apt-get:\n\n $ apt-get install \\\n python3-fixtures \\\n python3-pgbouncer \\\n python3-psycopg2 \\\n python3-testresources \\\n python3-timeline \\\n python3-transaction \\\n python3-twisted \\\n python3-zope.component \\\n python3-zope.security\n\nAlternatively, dependencies can be downloaded as eggs into the current\ndirectory with:\n\n $ make develop\n\nThis ensures that all dependencies are available, downloading from\nPyPI as appropriate.\n\nDatabase setup\n--------------\n\nMost database setup is done automatically by the test suite. However,\nUbuntu's default MySQL packaging ships an AppArmor profile that prevents it\nfrom writing to a local data directory. To allow the test suite to do this,\nyou will need to grant it access, which is most easily done by adding a line\nsuch as this to /etc/apparmor.d/local/usr.sbin.mysqld:\n\n /path/to/storm/** rwk,\n\nThen reload the profile:\n\n $ sudo aa-enforce /usr/sbin/mysqld\n\nRunning the tests\n-----------------\n\nFinally, its time to run the tests! Go into the base directory of\nthe storm branch you want to test, and run:\n\n $ make check\n\nThey'll take a while to run. All tests should pass: failures mean\nthere's a problem with your environment or a bug in Storm.\n",
"bugtrack_url": null,
"license": "LGPL",
"summary": "Storm is an object-relational mapper (ORM) for Python developed at Canonical.",
"version": "1.0",
"project_urls": {
"Download": "https://launchpad.net/storm/+download",
"Homepage": "https://storm.canonical.com"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "91fa55c42c89fc485c2669a0f4bccfd8d768efd7016671c4c19b2b5915057003",
"md5": "8043fd49418c3eaa692c47e55f14f798",
"sha256": "9b434d3ce3248bd1fc86b8406c5dcc3350585d4512f1a7f6731aa97688ead841"
},
"downloads": -1,
"filename": "storm-1.0.tar.gz",
"has_sig": false,
"md5_digest": "8043fd49418c3eaa692c47e55f14f798",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 285108,
"upload_time": "2024-07-16T18:02:28",
"upload_time_iso_8601": "2024-07-16T18:02:28.613358Z",
"url": "https://files.pythonhosted.org/packages/91/fa/55c42c89fc485c2669a0f4bccfd8d768efd7016671c4c19b2b5915057003/storm-1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-16 18:02:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "storm"
}
