Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Readme #544

Open
wants to merge 1 commit into
base: orm
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 30 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,27 @@
# Downloads
[![Downloads](https://pepy.tech/badge/pony)](https://pepy.tech/project/pony) [![Downloads](https://pepy.tech/badge/pony/month)](https://pepy.tech/project/pony/month) [![Downloads](https://pepy.tech/badge/pony/week)](https://pepy.tech/project/pony/week)


Pony Object-Relational Mapper
=============================
[![Downloads](https://pepy.tech/badge/pony)](https://pepy.tech/project/pony) [![Downloads](https://pepy.tech/badge/pony/month)](https://pepy.tech/project/pony/month) [![Downloads](https://pepy.tech/badge/pony/week)](https://pepy.tech/project/pony/week)

Pony is an advanced object-relational mapper. The most interesting feature of Pony is its ability to write queries to the database using Python generator expressions and lambdas. Pony analyzes the abstract syntax tree of the expression and translates it into a SQL query.

Here is an example query in Pony:

Here is an example of generator query in Pony:
```python
select(p for p in Product if p.name.startswith('A') and p.cost <= 1000)
```
Or the same query using lambda syntax:
```python
Product.select(lambda p: p.name.startswith('A') and p.cost <= 1000 )
```
Pony works with SQLite, MySQL, PostgreSQL and Oracle databases.

Pony translates queries to SQL using a specific database dialect. Currently Pony works with SQLite, MySQL, PostgreSQL and Oracle databases.

By providing a Pythonic API, Pony facilitates fast app development. Pony is an easy-to-learn and easy-to-use library. It makes your work more productive and helps to save resources. Pony achieves this ease of use through the following:
Pony is an easy-to-learn and easy-to-use library. It makes your work more productive and helps to save resources.

Main features:
* Compact entity definitions
* The concise query language
* Ability to work with Pony interactively in a Python interpreter
* Comprehensive error messages, showing the exact part where an error occurred in the query
* Displaying of the generated SQL in a readable format with indentation
* Ability to work with Pony interactively in a Python interpreter

All this helps the developer to focus on implementing the business logic of an application, instead of struggling with a mapper trying to understand how to get the data from the database.

Expand All @@ -34,24 +36,24 @@ Pony ORM is Apache 2.0 licensed open source project. If you would like to suppor
[Become a backer or sponsor](https://ponyorm.org/donation.html)


Online tool for database design
-------------------------------

Pony ORM also has the Entity-Relationship Diagram Editor which is a great tool for prototyping. You can create your database diagram online at [https://editor.ponyorm.com](https://editor.ponyorm.com), generate the database schema based on the diagram and start working with the database using declarative queries in seconds.


Documentation
-------------

Documenation is available at [https://docs.ponyorm.org](https://docs.ponyorm.org)
The documentation source is avaliable at [https://github.com/ponyorm/pony-doc](https://github.com/ponyorm/pony-doc).
Documentation is available at [docs.ponyorm.org](https://docs.ponyorm.org). <br>
Check out the [Getting Started](https://docs.ponyorm.org/firststeps.html) page for a quick overview. <br>
The documentation source is available at [github.com/ponyorm/pony-doc](https://github.com/ponyorm/pony-doc).
Please create new documentation related issues [here](https://github.com/ponyorm/pony-doc/issues) or make a pull request with your improvements.


License
-------
How PonyORM does its tricks?
----------------------------
[Here is a detailed answer](https://stackoverflow.com/a/16118756)

Pony ORM is released under the Apache 2.0 license.

Online tool for database design
-------------------------------

Pony ORM also has the Entity-Relationship Diagram Editor which is a great tool for prototyping. You can create your database diagram online at [editor.ponyorm.com](https://editor.ponyorm.com), generate the database schema based on the diagram and start working with the database using declarative queries in seconds.


PonyORM community
Expand All @@ -62,4 +64,10 @@ Meet the PonyORM team, chat with the community members, and get your questions a
Join our newsletter at [ponyorm.org](https://ponyorm.org).
Reach us on [Twitter](https://twitter.com/ponyorm).

Copyright (c) 2013-2019 Pony ORM. All rights reserved. info (at) ponyorm.org

License
-------

Pony ORM is released under the Apache 2.0 license.

Copyright (c) 2013-present Pony ORM. All rights reserved. info (at) ponyorm.org