deviras/README.md

68 lines
2.8 KiB
Markdown
Raw Normal View History

2022-08-18 11:40:20 +05:30
# deviras
2022-08-19 23:15:48 +05:30
> Bunch of scripts to automate stuff around the developersIndia subreddit
2022-08-19 22:51:31 +05:30
2023-02-06 20:15:58 +05:30
[![Discord](https://img.shields.io/discord/669880381649977354?color=%237289da&label=Discord&logo=Discord)](https://discordapp.com/invite/MKXMSNC)
[![Subreddit subscribers](https://img.shields.io/reddit/subreddit-subscribers/developersIndia?style=social)](https://www.reddit.com/r/developersIndia/)
[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg)](#contributors-)
2022-08-19 23:24:49 +05:30
## Scripts
2022-08-19 22:51:31 +05:30
2023-02-09 17:09:22 +05:30
### [idcard_update](https://github.com/developersIndia/deviras/blob/idcard_update)
2022-08-31 19:03:24 +05:30
Used for changing the text below total members & live members count in a subreddit.
2022-08-19 23:24:49 +05:30
2022-08-31 19:03:24 +05:30
![r/developersIndia About widget](https://user-images.githubusercontent.com/34342551/185678556-e4c911c9-fb12-49da-9ca6-8f8ce2ad9b5a.png)
2022-08-19 22:51:31 +05:30
2022-08-31 19:03:24 +05:30
## Setup
2022-08-31 19:03:24 +05:30
1. Clone the repo
2022-08-31 19:03:24 +05:30
```bash
git clone https://github.com/developersIndia/deviras.git
```
2. Initialise a virtual environment.
2022-08-19 22:51:31 +05:30
2022-08-31 19:03:24 +05:30
```bash
cd deviras
python3 -m venv venv
source venv/bin/activate
```
3. Install dependencies
```bash
pip install -r requirements.txt
```
4. To run the tests, use the following command in a python virtual environment:
```bash
python -m unittest
```
## Resources & Learning Material
2022-08-19 23:24:49 +05:30
- [PRAW Docs](https://praw.readthedocs.io/en/stable/code_overview/other/idcard.html)
2022-08-20 22:37:03 +05:30
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="https://github.com/SameerSahu007"><img src="https://avatars.githubusercontent.com/u/29480670?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sameer Sahu</b></sub></a><br /><a href="https://github.com/developersIndia/deviras/commits?author=SameerSahu007" title="Code">💻</a></td>
2022-08-20 22:39:18 +05:30
<td align="center"><a href="http://pavanjadhaw.me"><img src="https://avatars.githubusercontent.com/u/26551780?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Pavan Jadhaw</b></sub></a><br /><a href="#ideas-pavanjadhaw" title="Ideas, Planning, & Feedback">🤔</a></td>
2022-08-31 18:55:52 +05:30
<td align="center"><a href="https://animesh-ghosh.github.io/"><img src="https://avatars.githubusercontent.com/u/34956994?v=4?s=100" width="100px;" alt=""/><br /><sub><b>MaDDogx</b></sub></a><br /><a href="https://github.com/developersIndia/deviras/commits?author=Animesh-Ghosh" title="Code">💻</a> <a href="https://github.com/developersIndia/deviras/commits?author=Animesh-Ghosh" title="Tests">⚠️</a></td>
2022-08-20 22:37:03 +05:30
</tr>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
2022-08-20 22:41:57 +05:30
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!