Metadata-Version: 2.1
Name: python-package-sync-tool
Version: 0.1.8
Summary: Small tool to sync package from different machines
Home-page: https://github.com/alex-ber/PythonPackageSyncTool
Author: Alexander Berkovich
License: Apache 2.0
Keywords: tools tool sync package pip
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Utilities
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Desktop Environment
Classifier: Topic :: Education
Classifier: Operating System :: OS Independent
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Natural Language :: English
Requires-Python: >=3.7.1
Description-Content-Type: text/markdown
Requires-Dist: PyYAML (==5.1)
Provides-Extra: tests
Requires-Dist: atomicwrites (==1.3.0) ; extra == 'tests'
Requires-Dist: attrs (==19.1.0) ; extra == 'tests'
Requires-Dist: colorama (==0.4.1) ; extra == 'tests'
Requires-Dist: mock (==2.0.0) ; extra == 'tests'
Requires-Dist: more-itertools (==6.0.0) ; extra == 'tests'
Requires-Dist: multidispatch (==0.2) ; extra == 'tests'
Requires-Dist: pbr (==5.1.3) ; extra == 'tests'
Requires-Dist: pluggy (==0.9.0) ; extra == 'tests'
Requires-Dist: py (==1.8.0) ; extra == 'tests'
Requires-Dist: pytest (==4.3.1) ; extra == 'tests'
Requires-Dist: pytest-assume (==1.2.2) ; extra == 'tests'
Requires-Dist: pytest-mock (==1.10.1) ; extra == 'tests'
Requires-Dist: PyYAML (==5.1) ; extra == 'tests'
Requires-Dist: six (==1.12.0) ; extra == 'tests'

## PythonPackageSyncTool

PythonPackageSyncTool is a Python utility to "fix" requirements.txt.

It is used to make manipulation on requirements.txt that is produces by 'pip freeze'

### Getting Help


### QuickStart
```bash
pip3 install python-package-sync-tool
```

##
```bash
cd /opt/anaconda3/lib/python3.7/site-packages/alexber/reqsync/data/
```
Note: This is Path where you're actually install my utility, it can be different in your machine.

If you use venv it will look something like:

```bash
cd /opt/MyProject/venv/Lib/site-packages/alexber/reqsync
```
##


Alternatively you can create sctipt file for yourself, named, say, driver.py:

```python3
#!/usr/bin/python3

import alexber.reqsync.app as app

if __name__ == "__main__":
   app.main()
```

Than create file config.yml near your script (see data/config.yml) or provide all parameter using command line
argruments. Use ':' in places where you should naturally write '==' (see explanation below).

Parammeters 'source' and 'destination' are required. You should also provide (requirements) file for 'source'.

'mutual_exclusion' has default value True.



##
Now, type

```bash
python3 -m alexber.reqsync.data --add=some_new_package:1.0.0
```

or if you're using script (driver.py) go the directory with the script and type
```bash
./driver.py --add=some_new_package:1.0.0
```
This will run quick check whether package is not in remove list. If it is, the utility will fail. You can override this
beahivor by supplying `--mutual_exclusion=False`. 

Then, this will add some_new_package with version 1.0.0 to the requirements-dest.txt

Note:

Semicolomn and not equal sign is used here due to Python limitaion of usage of equal sign in the value in the command line.

You can specified multiple packages using comma delimiter.

You can specifiy path to your config file using `--config_file`.

It can be absolute or relative. If you're running using script (driver.py), that it can be relative to the directory 
whether you put your script. If you're running as the module (`python3 -m`), it can be relative to 
`/opt/anaconda3/lib/python3.7/site-packages/alexber/reqsync/data/` (exact path can be different, see above).  

##
You can supplied multiply packages by using comma:


```bash
python3 -m alexber.reqsync.data --add=some_new_package:1.0.0,another_new_package:2.0.0
```

or if you're using script (driver.py) go the directory with the script and type
```bash
./driver.py --add=some_new_package:1.0.0,another_new_package:2.0.0
```



### Installing from source
```bash
python3 -m pip install . # only installs "required"
```
```bash
python3 -m pip install .[test] # installs dependencies for tests
```
##

From the directory with setup.py
```bash
python3 setup.py test #run all tests
```
```bash
pytest
```



## Requirements


PythonPackageSyncTool requires the following modules.

* Python 3.7+

* PyYAML==5.1

# Changelog
All notable changes to this project will be documented in this file.

\#https://pypi.org/manage/project/python-package-sync-tool/releases/

## [Unrelased]
Add test

+ --add=zzzzzzzzzzzzzzzzzz,
+ --add=awscli
+ --add=awscli,
+ --add=not_exists
+ --add=not_exists,
- --add=aaaaaaaaaaaaaaaaaaa
- Change assert to more thoroguh
- --remove=zzzzzzzzzzzzzzzzzz,
- --remove=awscli
- --remove=awscli,
- --remove=not_exists
- --remove=not_exists,
##
*   Test mutual exclusion

*   Test & fix use of buffer

##

## [0.1.7] - 2019-05-20
### Removed
- Some project cleanup.

### Changed
- CHANGELOG and REAMDE now use Markdown format.
- REAMDE totally rewritten.
- Fixing bugs in the core algorithm. Simplifying code.
- Fixing correct handling of package adding to the buttom of the list. 


## [0.1.6] - 2019-05-20
### Added
- `__init__.py` file added to alexber.reqsync.data.

## [0.1.5] - 2019-05-20
### Added
- Small tool to sync package from different machines.








