Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add setup.py, document installation via pip (only) in README #9

Merged
merged 1 commit into from
Jan 14, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,21 @@ Primary used for remote backup of projects in GitLab.com to private storage serv
Code was modified to work with Python3, not longer compatible with Python2.

## Prerequisite
* Python Requests library, `sudo pip install requests`
* Configured Gitlab API Token, https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html

## Install

Simple just clone the project.
Simply install via pip:

`git clone https://github.com/rvojcik/gitlab-project-export`
`pip install git+https://github.com/rvojcik/gitlab-project-export`

or clone the project and install dependecies manually:

```
git clone https://github.com/rvojcik/gitlab-project-export
pip install pyyaml
pip install requests
```

Prepare and edit your config file

Expand Down
31 changes: 31 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
from os.path import join as path_join, dirname
from setuptools import setup, find_packages

version = '0.1'
README = path_join(dirname(__file__), 'README.md')
long_description = open(README).read()
setup(
name='gitlab-project-export',
version=version,
description=('Simple python project for exporting gitlab projects '
'with Export Project feature in GitLab API.'),
long_description=long_description,
classifiers=[
'Development Status :: 4 - Beta',
'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
'Programming Language :: Python',
],
author='Robert Vojcik',
author_email='robert@vojcik.net',
url='https://github.com/rvojcik/gitlab-project-export',
download_url='https://github.com/rvojcik/gitlab-project-export/archive/master.tar.gz',
packages=(['lib']),
install_requires = [
'pyyaml',
'requests',
],
scripts=[
'gitlab-project-export.py',
'gitlab-project-import.py',
],
)