enpaul
/
peewee-plus
mirror of https://github.com/enpaul/peewee-plus.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Remove source code links from readme to support cross platform pubs 

These links would change whenever there was a software update and never
worked on PyPI, so it's best to just remove them
This commit is contained in:
Ethan Paul 2023-05-04 14:55:56 -04:00
parent 5f81f7cef7
commit 19b149c5c2
2 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
CODE_OF_CONDUCT.md
View File

@ -27,9 +27,10 @@ Examples of unacceptable behavior include:
- The use of sexualized language or imagery, and sexual attention or advances of any kind - The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks - Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment - Public or private harassment
- Publishing others' private information, such as a physical or email address, without their - Publishing others' private information, such as a physical or email address, without
explicit permission their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting - Other conduct which could reasonably be considered inappropriate in a professional
setting
## Enforcement Responsibilities ## Enforcement Responsibilities
@ -52,8 +53,8 @@ offline event.
## Enforcement ## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the
community leaders responsible for enforcement at \[INSERT CONTACT METHOD\]. All community leaders responsible for enforcement at \[INSERT CONTACT METHOD\]. All complaints
complaints will be reviewed and investigated promptly and fairly. will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of All community leaders are obligated to respect the privacy and security of the reporter of
any incident. any incident.
@ -105,8 +106,8 @@ toward or disparagement of classes of individuals.
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct Community Impact Guidelines were inspired by
enforcement ladder](https://github.com/mozilla/diversity). [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
For answers to common questions about this code of conduct, see the FAQ at For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/faq. Translations are available at

25
README.md
View File

@ -14,7 +14,8 @@ release history.
## Documentation ## Documentation
*The documentation for this project is currently a work in progress. Please see the source code for complete docs* *The documentation for this project is currently a work in progress. Please see the source
code for complete docs*
- [Installing](#installing) - [Installing](#installing)
- [Features](#features) - [Features](#features)
@ -57,34 +58,32 @@ when using SQLite
### Functions ### Functions
[`calc_batch_size`](blob/devel/peewee_plus.py#L93) - Helper function for writing `calc_batch_size` - Helper function for writing backend-agnostic batch queries while
backend-agnostic batch queries while accounting for the accounting for the
[SQLite max variable limit](https://www.sqlite.org/limits.html#max_variable_number). [SQLite max variable limit](https://www.sqlite.org/limits.html#max_variable_number).
[`flat_transaction`](blob/devel/peewee_plus.py#L159) - Decorator function for wrapping `flat_transaction` - Decorator function for wrapping callables in a database transaction
callables in a database transaction without creating nested transactions without creating nested transactions
### Classes ### Classes
[`PathField`](blob/devel/peewee_plus.py#204) - A Peewee database field for storing `PathField` - A Peewee database field for storing
[Pathlib](https://docs.python.org/3/library/pathlib.html) objects, optionally relative to [Pathlib](https://docs.python.org/3/library/pathlib.html) objects, optionally relative to
a runtime value. a runtime value.
[`PrecisionFloatField`](blob/devel/peewee_plus.py#L262) - A Peewee database field for `PrecisionFloatField` - A Peewee database field for storing floats while specifying the
storing floats while specifying the
[MySQL precision parameters](https://dev.mysql.com/doc/refman/8.0/en/floating-point-types.html) [MySQL precision parameters](https://dev.mysql.com/doc/refman/8.0/en/floating-point-types.html)
`M` and `D` `M` and `D`
[`JSONField`](blob/devel/peewee_plus.py#L293) - A Peewee database field for storing `JSONField` - A Peewee database field for storing arbitrary JSON-serializable data
arbitrary JSON-serializable data
[`EnumField`](blob/devel/peewee_plus.py#L348) - A Peewee database field for storing Enums `EnumField` - A Peewee database field for storing Enums by name
by name
## For Developers ## For Developers
All project contributors and participants are expected to adhere to the All project contributors and participants are expected to adhere to the
[Contributor Covenant Code of Conduct, v2](CODE_OF_CONDUCT.md) ([external link](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)). [Contributor Covenant Code of Conduct, v2](CODE_OF_CONDUCT.md)
([external link](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)).
The `devel` branch has the latest (and potentially unstable) changes. The stable releases The `devel` branch has the latest (and potentially unstable) changes. The stable releases
are tracked on [Github](https://github.com/enpaul/peewee-plus/releases), are tracked on [Github](https://github.com/enpaul/peewee-plus/releases),