Metadata-Version: 2.1
Name: so-pip
Version: 0.1.21
Summary: Generate packages from Stackoverflow answers
Home-page: https://github.com/matthewdeanmartin/so_pip
License: MIT
Keywords: packaging,stackoverflow
Author: Matthew Martin
Author-email: matthewdeanmartin@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: 2to3
Requires-Dist: beautifulsoup4
Requires-Dist: black
Requires-Dist: html2text
Requires-Dist: jinja2
Requires-Dist: nbformat
Requires-Dist: pip-upgrader
Requires-Dist: pipreqs
Requires-Dist: pur
Requires-Dist: py-stackexchange
Requires-Dist: pyflakes
Requires-Dist: pypinfo
Requires-Dist: pypistats
Requires-Dist: pyrankvote
Requires-Dist: python-dotenv
Requires-Dist: pyupgrade
Requires-Dist: requests
Requires-Dist: stackapi
Requires-Dist: stdlib-list
Project-URL: Bug Tracker, https://github.com/matthewdeanmartin/so_pip/issues
Project-URL: Change Log, https://github.com/matthewdeanmartin/so_pip/blob/main/CHANGES.md
Project-URL: Documentation, https://github.com/matthewdeanmartin/so_pip
Project-URL: Repository, https://github.com/matthewdeanmartin/so_pip
Description-Content-Type: text/markdown

so_pip
======
Everyone copies code from StackOverflow, but no one is formalizing it.

This will vendorize the source code of question or answer into a folder and
generate the accessory files to make it look like a python package.

The feature-set overlaps a bit with [cookie cutter, vendorizing libraries and
stackoverflow search cli's](https://github.com/matthewdeanmartin/so_pip/blob/main/docs/prior_art.md).

Installation
------------
Requires Python 3.7+, tested with 3.7, 3.8, 3.9
```
git clone https://github.com/matthewdeanmartin/so_pip.git
python -m venv venv
. venv/Scripts/activate
pip install -r .config/requirements.txt
# some tools can't co-exist in the same virtual environment
pipx install pylint
pipx install isort
python -m so_pip --version
```
Docker support 1/2 implemented.
```
docker build -t so_pip:latest .
```
Usage
--------------
Consider getting a [key](https://stackapps.com/apps/oauth/register) and adding a [.so_pip.ini file](https://github.com/matthewdeanmartin/so_pip/blob/main/.so_pip.ini) The app will make best efforts if you don't.
```
# Turn posts into nicely formated packages
> so_pip vendorize my_name --question=31049648 | --answer=31049648
> so_pip search --answer=31049648 --tags=python

# Pip-like commands
> so_pip uninstall | upgrade {package_name}
> so_pip list | freeze
```

Docs
-----
* [Examples](https://github.com/matthewdeanmartin/so_pip/tree/main/examples)
* [CLI](https://github.com/matthewdeanmartin/so_pip/blob/main/docs/cli.md)
* [Code reuse scanarios you see on StackOverflow](https://github.com/matthewdeanmartin/so_pip/blob/main/docs/scenarios.md)
* [Features](https://github.com/matthewdeanmartin/so_pip/blob/main/docs/features.md)
* [Security Considerations](https://github.com/matthewdeanmartin/so_pip/blob/main/docs/security.md)
* [Prior Art](https://github.com/matthewdeanmartin/so_pip/blob/main/docs/prior_art.md) Similar and overlapping tools.
* [Contributing *answers* to StackOverflow](https://github.com/matthewdeanmartin/so_pip/blob/main/docs/contributing.md) AKA, fixing answers you found.
* [Attribution Compliance](https://github.com/matthewdeanmartin/so_pip/blob/main/docs/comply_with_cc_sa.md)
* [Contributing to so_pip](https://github.com/matthewdeanmartin/so_pip/blob/main/CONTRIBUTING.md)
* [Code of Conduct for so_pip](https://github.com/matthewdeanmartin/so_pip/blob/main/CODE_OF_CONDUCT.md)

