journal-rss


Namejournal-rss JSON
Version 0.0.1 PyPI version JSON
download
home_page
SummaryA FastAPI web server for creating RSS feeds for scholarly journals with the magic of adversarial interoperability
upload_time2024-01-04 03:28:35
maintainer
docs_urlNone
authorsneakers-the-rat
requires_python>=3.11,<4.0
licenseGPL-3.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # journal-rss

A FastAPI web server for creating RSS feeds for scholarly journals with the magic of adversarial interoperability

Many journals still have RSS feeds. Some don't though, as they try
and squeeze everyone onto their platforms to monetize our 
engagement data.

This is a simple web app for creating RSS feeds for journals by
collecting metadata from crossref. Dependencies are kept minimal, as
is deployment - No webpack, no complex build, no postgres,
just pip install and press play :).

# usage

(to be completed when main docs are, for now here's something brief)

```bash
git clone https://github.com/sneakers-the-rat/journal-rss
cd journal-rss
python -m venv ./venv
source ./venv/bin/activate
pip install .
python -m journal_rss
```

# progress

Everything is just getting started! things will break and change!

API:
- [x] Query Crossref for journal
- [x] Write journal metadata to db
- [x] Paginate papers by journal
- [x] Store papers in db
- [x] Populate papers when feed created
- [ ] Create RSS feed from papers by issn
- [ ] Cache RSS feeds
- [ ] Scheduled update of feed metadata

Frontend
- [x] Search for journal
- [x] Display list of journals
- [ ] Pages for each journal
- [x] Create new feed button
- [ ] Copy feed link
- [ ] Export feeds

# Credits

- https://github.com/marty331/fasthtmx/
- https://samherbert.net/svg-loaders/
- https://htmx.org/examples/active-search/

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "journal-rss",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.11,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "sneakers-the-rat",
    "author_email": "JLSaunders987@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/cc/44/d67d5d5e8b730ad239ff83eef7656171fedebf4bfe169db2a58527fc2254/journal_rss-0.0.1.tar.gz",
    "platform": null,
    "description": "# journal-rss\n\nA FastAPI web server for creating RSS feeds for scholarly journals with the magic of adversarial interoperability\n\nMany journals still have RSS feeds. Some don't though, as they try\nand squeeze everyone onto their platforms to monetize our \nengagement data.\n\nThis is a simple web app for creating RSS feeds for journals by\ncollecting metadata from crossref. Dependencies are kept minimal, as\nis deployment - No webpack, no complex build, no postgres,\njust pip install and press play :).\n\n# usage\n\n(to be completed when main docs are, for now here's something brief)\n\n```bash\ngit clone https://github.com/sneakers-the-rat/journal-rss\ncd journal-rss\npython -m venv ./venv\nsource ./venv/bin/activate\npip install .\npython -m journal_rss\n```\n\n# progress\n\nEverything is just getting started! things will break and change!\n\nAPI:\n- [x] Query Crossref for journal\n- [x] Write journal metadata to db\n- [x] Paginate papers by journal\n- [x] Store papers in db\n- [x] Populate papers when feed created\n- [ ] Create RSS feed from papers by issn\n- [ ] Cache RSS feeds\n- [ ] Scheduled update of feed metadata\n\nFrontend\n- [x] Search for journal\n- [x] Display list of journals\n- [ ] Pages for each journal\n- [x] Create new feed button\n- [ ] Copy feed link\n- [ ] Export feeds\n\n# Credits\n\n- https://github.com/marty331/fasthtmx/\n- https://samherbert.net/svg-loaders/\n- https://htmx.org/examples/active-search/\n",
    "bugtrack_url": null,
    "license": "GPL-3.0",
    "summary": "A FastAPI web server for creating RSS feeds for scholarly journals with the magic of adversarial interoperability",
    "version": "0.0.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "14597d12d390205702dbd845b2b8d76b278b59d9c430b340025bc8f5d15cbfa2",
                "md5": "06be42b9533648e17c8884230a79812b",
                "sha256": "a3570178f6b614414c5e35f75d1247eae70e1031e3759dcb70f19925bf1c8280"
            },
            "downloads": -1,
            "filename": "journal_rss-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "06be42b9533648e17c8884230a79812b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11,<4.0",
            "size": 26123,
            "upload_time": "2024-01-04T03:28:33",
            "upload_time_iso_8601": "2024-01-04T03:28:33.768357Z",
            "url": "https://files.pythonhosted.org/packages/14/59/7d12d390205702dbd845b2b8d76b278b59d9c430b340025bc8f5d15cbfa2/journal_rss-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cc44d67d5d5e8b730ad239ff83eef7656171fedebf4bfe169db2a58527fc2254",
                "md5": "63761451310a9fb48f13486f115b5ae4",
                "sha256": "1c57366ea28911b7bb8053133c7136edf62a839b011e59d7d13c524ad3c09775"
            },
            "downloads": -1,
            "filename": "journal_rss-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "63761451310a9fb48f13486f115b5ae4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11,<4.0",
            "size": 22720,
            "upload_time": "2024-01-04T03:28:35",
            "upload_time_iso_8601": "2024-01-04T03:28:35.614968Z",
            "url": "https://files.pythonhosted.org/packages/cc/44/d67d5d5e8b730ad239ff83eef7656171fedebf4bfe169db2a58527fc2254/journal_rss-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-04 03:28:35",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "journal-rss"
}
        
Elapsed time: 0.31712s