Description: Spicfy is a plugin for Neovim that seamlessly integrates Spotify functionality into the text editor environment. It provides users with the ability to search for songs, view search results within a popup window, and play selected songs directly from Neovim. This integration enhances user experience by allowing for convenient access to music playback while coding or working within the editor.
Key Features:
-
Spotify Integration: Spicfy leverages the Spotify API to enable seamless interaction with the Spotify platform directly from within Neovim.
-
Popup Interface: Upon initiating a search, Spicfy creates a popup window within the Neovim interface to display search results. This intuitive interface allows users to view and select songs without leaving the editor.
-
Interactive Selection: Users can navigate through the list of search results using familiar Neovim keybindings and select a song to play, enhancing usability and efficiency.
-
Playback Control: Spicfy enables users to control playback of selected songs by utilizing the Spotify API. Users can play, pause, skip, and control volume without leaving the Neovim environment. (working)
Contributing to Spicfy: Contributions to Spicfy are highly appreciated and welcome from developers of all skill levels. To contribute, follow these guidelines:
-
Fork the Repository: Start by forking the Spicfy repository on GitHub to your own GitHub account.
-
Clone the Repository: Clone your fork of the repository to your local machine using Git.
git clone https://github.com/your-username/spicfy.git
-
Install Dependencies: Ensure you have all the necessary dependencies installed, including Python, Neovim, and any required Python packages.
-
Set Up Environment: Obtain Spotify Developer credentials (client ID, client secret) and update the
.envfile with your credentials. -
Make Changes: Implement your changes or additions to the Spicfy plugin. This could include bug fixes, new features, improvements to existing features, documentation updates, etc.
-
Test Your Changes: Before submitting a pull request, thoroughly test your changes to ensure they work as intended and do not introduce any regressions.
-
Commit Your Changes: Once satisfied with your changes, commit them to your forked repository with descriptive commit messages.
git add . git commit -m "Description of changes"
-
Push Changes: Push your changes to your fork on GitHub.
git push origin main
-
Submit a Pull Request: Submit a pull request from your forked repository to the main Spicfy repository. Provide a clear and concise description of your changes in the pull request.
-
Review and Collaborate: Participate in the review process by addressing any feedback or comments provided by maintainers. Collaboration is key to improving Spicfy.
-
Celebrate Your Contribution: Once your pull request is merged, celebrate your contribution to Spicfy! Your efforts help make Spicfy better for all users.
Thank you for your interest in contributing to Spicfy. Your contributions are valuable and contribute to the growth and improvement of the plugin. If you have any questions or need assistance, feel free to reach out to the project maintainers. Happy coding and listening! 👍