Skip to content

Latest commit

 

History

History
179 lines (124 loc) · 7.4 KB

README.md

File metadata and controls

179 lines (124 loc) · 7.4 KB
Raw

Briefly-logo

nlt-github

Gitter KWoC 2018 contribution

nlt-github is an open source project which makes sure that you don't have to leave your beloved terminal to upload a new project in Github

Demo

Installation

$ git clone https://github.com/dibyasonu/nlt-github.git

$ pip install --editable .

Steps

  1. First we need to create a user. Creating a user creates a personal access token and stores the data to access the token locally

    $ nlt config --adduser

  2. We add files like gitignore, LICENSE and README. (Optional)

    $ nlt add --gitignore shows templates list for different languages, the user can select any no of languages and accordingly gitignore is addded to your project folder.

    $ nlt add --license shows templates list for different LICENSE, the user can select any one and LICENSE file is generated and accordingly addded to your project folder.

    $ nlt add --readme adds a README.md to your project.

  3. We create a Repo in your github account. We upload the project from the terminal.

    $ nlt create-remote Prompts for the username and the details like repo name and Description of the repo. It creates a repo according to given details, and adds its remote address to the origin referrence to the local project.

    $ nlt create-remote --privy It does the above task but the repo created is a private repo.

    Now you can push the project simply by git push --all

Usage

$ nlt --help

Usage: nlt [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  add            Add required files
  config         Configure Users
  create-remote  create a new repo in Github and add remote origin to the
                 local project.
  list-repos     view list of repositories belonging to the user.
  pr             list pull requests of current repository
  view-profile   view basic info of any particular user.

Add required files

$ nlt add --help

Usage: nlt add [OPTIONS]

  Add required files

Options:
  --license    Add license templates from the list to your project.
  --gitignore  Add gitignore template from the list to your Project.
  --readme     Addd README to your project.

Configure Users

$ nlt config --help

Usage: nlt config [OPTIONS]

  Configure Users

Options:
  --adduser    Creates a personal access token in github and stores them locally.
  --deluser    Remove created personal access token from github and locally.
  --showusers  Show added users.

Create repo

$ nlt create-remote --help

Usage: nlt create-remote [OPTIONS]

Options:
  --username TEXT  provide username in whose account the new repo is to be created.
  --privy          create a private repository if used.

List repo

$ nlt list-repos --help

Usage: nlt list-repos [OPTIONS]

  view list of repositories belonging to the user, private repositories can
  also be listed if user is configured.

Options:
  --username TEXT  provide username in whose repos are to be listed.
  --all            specify if private repos are needed,in that case username
                   must be configured.
  --help           Show this message and exit.

Handle Pull Request

$ nlt pr --help

Usage: nlt pr [OPTIONS]

  list open pull requests at remote of current git repository test them,
  merge them or comment on the thread

Options:
  --help  Show this message and exit.

View Profile

$ nlt view-profile --help

Usage: nlt view-profile [OPTIONS]

  view basic profile information of a particular user

Options:
  --username TEXT  provide username in whose info is needed.
  --all            specify if private repos count is needed,in that case
                   username must be configured.
  --help           Show this message and exit.

Contributing

  • We're are open to enhancements & bug-fixes 😄.
  • Feel free to add issues and submit patches

Author

Dibya Ranjan Jena - dibyasonu

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT - see the LICENSE file for details