Skip to content

Commit

Permalink
fix: setup readme content
Browse files Browse the repository at this point in the history
  • Loading branch information
lpmatos committed Jul 28, 2020
1 parent 4fbbf6f commit 96f122e
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 48 deletions.
46 changes: 9 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,14 @@
**GitLabRC** (GitLab Recursive Clone)
# Gitlab Cloner

This Python CLI is a very simple tool that help you to clone all projects inside a [gitlab](http://www.gitlab.com) group.
This is a program that clones all git repositories of a user from a
Gitlab server.

This project is inspired from [gitup](https://github.com/ezbz/gitlabber) and has parts taken from there.
This requires the user's API access token.

### Usage
## Usage

usage: gitlabcr [-h] [-u <url>] [-t <token>] [-n <namespace>] [-p <path>] [--disable-root] [--version]
Use the Gitlab Server's URL as the first positional argument, the second
one should be the API key.

Gitlabrc - clones all projects inside namespaces

optional arguments:
-h, --help show this help message and exit
-u <url>, --url <url>
base URL of GitLab instance
-t <token>, --token <token>
token GitLab API
-n <namespace>, --namespace <namespace>
namespace in GitLab to clone all projects
-p <path>, --path <path>
destination path for cloned projects
--disable-root do not create root namepace folder in path
--version show version

### Exemples

* Clone all repositories inside specific namespace in current directory:

gitlabrc -u $GITLAB_URL -t $GITLAB_TOKEN -n msp/charts

* Clone all repositories inside specific namespace in specific directory:

gitlabrc -u $GITLAB_URL -t $GITLAB_TOKEN -n msp/charts -p /home/ubuntu

* Getting repositories with specific git clone method:

gitlabrc -u $GITLAB_URL -t $GITLAB_TOKEN -n msp/charts -p /home/ubuntu -m http

* Show all repositories without clone/fetch:

gitlabrc -u $GITLAB_URL -t $GITLAB_TOKEN -n msp/charts --dry-run
You can also specify a destination directory for the repositories
with the ```-d``` argument.
2 changes: 1 addition & 1 deletion gitlabrc/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-

VERSION = (0, 0, 17)
VERSION = (0, 0, 1)

__version__ = ".".join(map(str, VERSION))
11 changes: 1 addition & 10 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# -*- coding: utf-8 -*-

from codecs import open
from gitlabrc import __version__
from os.path import abspath, dirname, join
from setuptools import setup, find_packages
Expand All @@ -22,20 +21,12 @@
# Getting current location of this file.
here = abspath(dirname(__file__))

# Import the README and use it as the long-description.
# Note: this will only work if 'README.md' is present in your MANIFEST.in file!
try:
with open(join(here, "README.md"), encoding="utf-8") as file:
longdesc = file.read()
except FileNotFoundError:
longdesc = DESCRIPTION

# Build setup package.
setup(
name = NAME,
version = VERSION,
description = DESCRIPTION,
long_description = longdesc,
long_description = open(join(here, "README.md"), "r").read(),
long_description_content_type = "text/markdown",
author = AUTHOR,
author_email = EMAIL,
Expand Down

0 comments on commit 96f122e

Please sign in to comment.