/forksearch

Collect and explore forks and stars for a github repository.

Primary LanguagePython

forksearch

Usage

  1. cd into project directory.

  2. Create a virtual environment.

$ make venv
  1. Activate it.
$ source venv/bin/activate
  1. Install development dependencies with editable mode to test the CLI.
$ make install

Take forksearch for a spin

First, you need to create a Github access token. You'll need repo and email permissions.

Then,

$ export GH_TOKEN=<GH_TOKEN>
$ cd forksearch
$ python main.py dbrumley/calculator

NOTE: Installation isn't working. To be fixed :)

Test with Docker

CLI commands can be tested with Docker.

  1. Build an image for the CLI.

    Image is tagged with the same name as the cli_command.

$ make docker-image
  1. Run the command inside the container.
$ docker-run --rm forksearch init

Documentation

  1. Install documentation-related dependencies.
$ make docs
  1. Serve the docs locally.
$ make serve-docs

Distribution

NOTE

Make sure you have account in PyPI before you try this out.

To publish you CLI to PyPI, run:

$ make distributions

dist directory will be created inside your project directory. Upload it to PyPI using:

$ twine dist/*

Help

For help related to make commands.

$ make help