| Name | feedwerk JSON |
| Version |
1.2.0
JSON |
| download |
| home_page | https://github.com/uniphil/feedwerk |
| Summary | The atom feed generator from werkzeug. |
| upload_time | 2024-01-28 16:42:14 |
| maintainer | |
| docs_url | None |
| author | phil |
| requires_python | >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.* |
| license | BSD-3-Clause |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# feedwerk
[Werkzeug](https://werkzeug.palletsprojects.com/) used to have an Atom/RSS feed
generator, which was pretty great, even if it didn't make the most sense as part
of the Werkzeug package.
This repository is a straight-forward extract of the [atom code](https://github.com/pallets/werkzeug/blob/0.16.1/src/werkzeug/contrib/atom.py)
from Werkzeug version `0.16.1`, including unit tests.
## install & migrate from werkzeug.contrib.atom
```py
$ pip install feedwerk
```
Rename imports `werkzeug.contrib.atom` → `feedwerk.atom`
```diff
- from werkzeug.contrib.atom import AtomFeed, FeedEntry
+ from feedwerk.atom import AtomFeed, FeedEntry
```
## bugs & maintenance
This project exists to help kick the can of migrating atom libraries when
upgrading werkzeug, so the only goal is compatibility with `0.16.1` of
`werkzeug.contrib.atom`. No new features will be considered. Bug fixes may be
rejected if they might be relied-on by anyone still using old Werkzeug.
On the other hand, if you like the API that Werkzeug used to have for atom
feeds, please feel free to fork this project and build and improve on it! I
managed (painfully!) to retain the git history for this module and its tests,
so I think it's a good starting place :)
## changes
### v1.2.0 2024-01-28
Python deprecated `datetime.datetime.utcnow()`:
- Use `datetime.now(timezone.utc)` with `.utcnow()` fallback for python 2.7 [#6](https://github.com/uniphil/feedwerk/pull/6/) [@uniphil](https://github.com/uniphil) with thanks to [@Siecje](https://github.com/Siecje) for [reporting it](https://github.com/uniphil/feedwerk/issues/5).
### v1.1.0 2022-04-24
Some features we depended on were deprecated in werkzeug 2.0 and removed in 2.1:
- remove `werkzeug.utils.escape` in favour of MarkupSafe [#2](https://github.com/uniphil/feedwerk/pull/2/) [@mar1ad](https://github.com/mar1ad)
- use `Response` instead of `werkzeug.wrappers.BaseResponse` [#3](https://github.com/uniphil/feedwerk/pull/3/) [@uniphil](https://github.com/uniphil)
Both changes are backwards-compatible with previous werkzeug back to 1.0. Client code that depends on the return type of `AtomFeed.get_response()` may need to be updated in rare cases.
## work on feedwerk
### run tests
```bash
$ python -m pytest
```
### lints
```bash
$ flake8 --max-line-length=100 *.py tests feedwerk
```
---
### Acknowledgements
The atom feed generator was written by Werkzeug developers from 2007–2019. The
project history affecting this code has been retained in version control; see
[contributors](https://github.com/uniphil/feedwerk/graphs/contributors). The
full source and history of Werkzeug is available at
[palletes/werkzeug](https://github.com/pallets/werkzeug). Werkzeug and this
project are free to use under the terms of the
[BSD 3-Clause License](./LICENSE.rst).
This project is not affiliated with Werkzeug.
Raw data
{
"_id": null,
"home_page": "https://github.com/uniphil/feedwerk",
"name": "feedwerk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
"maintainer_email": "",
"keywords": "",
"author": "phil",
"author_email": "phil@commit--blog.com",
"download_url": "https://files.pythonhosted.org/packages/b8/9f/be749aa9656ec54665e4cc38c6ecabcd1013be13ccc7732688c200feaad6/feedwerk-1.2.0.tar.gz",
"platform": null,
"description": "# feedwerk\n\n[Werkzeug](https://werkzeug.palletsprojects.com/) used to have an Atom/RSS feed\ngenerator, which was pretty great, even if it didn't make the most sense as part\nof the Werkzeug package.\n\nThis repository is a straight-forward extract of the [atom code](https://github.com/pallets/werkzeug/blob/0.16.1/src/werkzeug/contrib/atom.py)\nfrom Werkzeug version `0.16.1`, including unit tests.\n\n\n\n## install & migrate from werkzeug.contrib.atom\n\n```py\n$ pip install feedwerk\n```\n\nRename imports `werkzeug.contrib.atom` \u2192 `feedwerk.atom`\n\n```diff\n- from werkzeug.contrib.atom import AtomFeed, FeedEntry\n+ from feedwerk.atom import AtomFeed, FeedEntry\n```\n\n## bugs & maintenance\n\nThis project exists to help kick the can of migrating atom libraries when\nupgrading werkzeug, so the only goal is compatibility with `0.16.1` of\n`werkzeug.contrib.atom`. No new features will be considered. Bug fixes may be\nrejected if they might be relied-on by anyone still using old Werkzeug.\n\nOn the other hand, if you like the API that Werkzeug used to have for atom\nfeeds, please feel free to fork this project and build and improve on it! I\nmanaged (painfully!) to retain the git history for this module and its tests,\nso I think it's a good starting place :)\n\n\n## changes\n\n### v1.2.0 2024-01-28\n\nPython deprecated `datetime.datetime.utcnow()`:\n\n- Use `datetime.now(timezone.utc)` with `.utcnow()` fallback for python 2.7 [#6](https://github.com/uniphil/feedwerk/pull/6/) [@uniphil](https://github.com/uniphil) with thanks to [@Siecje](https://github.com/Siecje) for [reporting it](https://github.com/uniphil/feedwerk/issues/5).\n\n\n### v1.1.0 2022-04-24\n\nSome features we depended on were deprecated in werkzeug 2.0 and removed in 2.1:\n\n- remove `werkzeug.utils.escape` in favour of MarkupSafe [#2](https://github.com/uniphil/feedwerk/pull/2/) [@mar1ad](https://github.com/mar1ad)\n- use `Response` instead of `werkzeug.wrappers.BaseResponse` [#3](https://github.com/uniphil/feedwerk/pull/3/) [@uniphil](https://github.com/uniphil)\n\nBoth changes are backwards-compatible with previous werkzeug back to 1.0. Client code that depends on the return type of `AtomFeed.get_response()` may need to be updated in rare cases.\n\n\n## work on feedwerk\n\n### run tests\n\n```bash\n$ python -m pytest\n```\n\n### lints\n\n```bash\n$ flake8 --max-line-length=100 *.py tests feedwerk\n```\n\n---\n\n### Acknowledgements\n\nThe atom feed generator was written by Werkzeug developers from 2007\u20132019. The\nproject history affecting this code has been retained in version control; see\n[contributors](https://github.com/uniphil/feedwerk/graphs/contributors). The\nfull source and history of Werkzeug is available at\n[palletes/werkzeug](https://github.com/pallets/werkzeug). Werkzeug and this\nproject are free to use under the terms of the\n[BSD 3-Clause License](./LICENSE.rst).\n\nThis project is not affiliated with Werkzeug.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "The atom feed generator from werkzeug.",
"version": "1.2.0",
"project_urls": {
"Code": "https://github.com/uniphil/feedwerk",
"Documentation": "https://github.com/uniphil/feedwerk",
"Homepage": "https://github.com/uniphil/feedwerk",
"Issue tracker": "https://github.com/uniphil/feedwerk/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b89fbe749aa9656ec54665e4cc38c6ecabcd1013be13ccc7732688c200feaad6",
"md5": "d4e4f5b6f4528616b093bf38540655ba",
"sha256": "c38feb4587f81eb37cd32780b1f7c60ece33c930adcd0e76c06cefdaabf077e9"
},
"downloads": -1,
"filename": "feedwerk-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "d4e4f5b6f4528616b093bf38540655ba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
"size": 11509,
"upload_time": "2024-01-28T16:42:14",
"upload_time_iso_8601": "2024-01-28T16:42:14.389681Z",
"url": "https://files.pythonhosted.org/packages/b8/9f/be749aa9656ec54665e4cc38c6ecabcd1013be13ccc7732688c200feaad6/feedwerk-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-28 16:42:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "uniphil",
"github_project": "feedwerk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "feedwerk"
}
