template-python-projects 1.5

Template Project in Python

# [template-python-projects](https://github.org/djclavero/template-python-projects)

Template Project for Python using git

by [e-mail]


## Installation

### Requirements
* Linux/Windows
* Python 2.7 and up

`$ pip install template-python-projects`

## Usage

```python
from video.formats import mp4play

# Call function
mp4play.test_mp4play()
```

## Create distribution
```
# Check the package first
$ python setup.py --help-commands
$ python setup.py check

# Create distribution
$ python setup.py sdist
```

## Upload release
```
$ twine upload dist/* # pip install twine (if required)
```

### .pypirc file
```
[pypi]
repository = https://upload.pypi.org/legacy/
username = djclavero
```

## Control of Versions (Git)
Create local repository:
```
# Create local repository
$ git init

# Create remote repository 'template-python-projects' in GitHub
```

Configuration:
```
$ git config --global user.name 'djclavero'
$ git config --global user.email [e-mail]

# Add remote repository
$ git remote add origin https://github.org/djclavero/template-python-projects

# Set .gitignore file
$ git config --global core.excludesFile C:\Users\David\.gitignore
```

Upload to remote repository:
```
# Add files and commit
$ git status
$ git add .
$ git commit -m "init commit"

# Upload to repository
$ git push origin master
```

### .gitignore file
```
# ignore bytecode python files
*.pyc
# ignore distribution files
dist/
*.egg-info/
# ignore spyder project files
.spyproject/
```


## License
[MIT](https://choosealicense.com/licenses/mit/)