Skip to content

Latest commit

 

History

History
176 lines (134 loc) · 7.26 KB

README.md

File metadata and controls

176 lines (134 loc) · 7.26 KB

defe logo

A Tech feed Aggregator for Developers

Read Stories which matter
Twitter URL

build GitHub release (latest by date) Website PyPI GitHub PyPI Downloads lgtm alerts Codacy Badge Language grade: Python Gitter

Built with ❤︎ by Bhupesh Varshney
Twitter Follow
The story behind defe

✨ Features

  • PWA
  • Share Stories
  • Minimal UI
  • Command Line Interface
  • Feeds from more than 100 sources categorized in
    • 📰 News
    • 🎙️ Podcasts
    • 📧 Newsletters ... And Much More

🌈 Demo

WebApp

CLI

📦 Package

You can use the defe package to build bots 🤖

from defe import defe
import pprint

f = defe.feed()

pprint.pprint(f.news(3))
pprint.pprint(f.feeders("newsletters"))

See Dcoumetation for more.

🔮 Installation

Install defe CLI using pip from PyPI

pip install defe

Development

  1. Clone the repository
git clone https://github.com/Bhupesh-V/defe.git
  1. Create virtual environment
python3 -m venv venv
  1. Activate virtual environment

    Linux/MacOS

    source venv/bin/activate

    Windows

    .\venv\Scripts\activate
  2. Install Dependencies

pip install -r requirements.txt
  1. Lint the project with
black --check --diff .
  1. Run the Development Server (for WebApp)
flask run
  1. To Use the defe CLI, run
python -m defe

📝 Changelog

See the CHANGELOG.md file for details.

Author

👥 Bhupesh Varshney

☺️ Show your support

Support me by giving a ⭐️ if this project helped you! or just Twitter URL

Donate using Liberapay Support on ko-fi

📜 License

This project is licensed under the GPL License. See the LICENSE file for details.

👋 Contributing

Please read the CONTRIBUTING guidelines for the process of submitting pull requests to us.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


AyushRawal

🐛

Jahir

🐛 💻

Arunaabh Pant

💻 🎨

Ozy Vielma

💻

This project follows the all-contributors specification. Contributions of any kind welcome!