soggyomelette / TheFirstFloor

A Poor Man's Spotify

TheFirstFloor™ - Part of The Building project

A Poor Man's Spotify

Table of Contents

1. About The Project
2. Getting Started
3. Usage
4. TODO
5. Contributing
6. License
7. Contact

About The Project

TheFirstFloor™ is aimed towards creating a CLI for managing your music requirements. It is a simple, easy to use, and lightweight music player. It is a work in progress and is not yet complete. Refer to TODO for more information.

Features

1. Login/Create user (Supporting hashing of passwords).
2. Stream songs online.
3. Download songs from all major sources (YouTube, Spotify, SoundCloud, etc.) as well as some miscellaneous sites.
4. Search for podcasts.
5. Listen to radio stations all around the world.
6. Identify music from media files or by recording.
7. Change user settings like search results per page, username, etc.
8. Strong error logging to help with future debugging.

(back to top)

Built With

1. Python
2. PostgreSQL

(back to top)

Getting Started

1. Use the log.sql file in the directory get the commands through which you can create your own database.
2. You can host the database on a platform like bit.io.
3. After hosting the database, Make a filekeys.py file in the directory and add the following lines:

postgresqluri = "<YOUR POSTGRESQL DATABASE URI>"
referralkey = "<YOUR REFERRAL KEY>"
spotclientid = "<YOUR SPOTIFY CLIENT ID>"
spotsecretid = "<YOUR SPOTIFY CLIENT SECRET ID>"

4. You can get your Spotify Client ID and Secret ID by following the steps here.
5. Voila! You can now use this CLI!

Prerequisites

1. You must download ffmpeg from here and extract it to the root of the C directory.
2. You must then add ffmpeg to your PATH environment variable.
3. Go to the directory where you downloaded the project and run the following command in the terminal:

pip install -r requirements.txt

(back to top)

Usage

There's no instructions, just run main.py in your terminal and follow the instructions on the screen!

(back to top)

TODO

• Make a playlist handler to play store a user's playlist and give option to download and play locally.
• Stream podcasts in the program rather than redirecting.
• Make a help menu.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Pratyush Shah - Email, LinkedIn

Project Link: https://github.com/pratyushvshah/TheFirstFloor

(back to top)