diff --git a/.gitignore b/.gitignore index 66b10c18..762cc89f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,135 @@ -*pyc -*__pycache__ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* .cache -.pytest_cache \ No newline at end of file +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ diff --git a/README.md b/README.md index 63894285..c096e149 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ # fetchcode A library to reliably fetch code via HTTP, FTP and version control systems. + +# Installation +Clone the repo using +`git clone https://github.com/nexB/fetchcode` + +Then install all the requirements using +`pip3 install -r requirements.txt` + +# Running Test Suite + +To run test suite +`python3 -m pytest` + diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..1e662359 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,18 @@ +attrs==19.3.0 +certifi==2019.11.28 +chardet==3.0.4 +idna==2.9 +importlib-metadata==1.5.0 +more-itertools==8.2.0 +packaging==20.1 +pathlib2==2.3.5 +pkg-resources==0.0.0 +pluggy==0.13.1 +py==1.8.1 +pyparsing==2.4.6 +pytest==5.3.5 +requests==2.23.0 +six==1.14.0 +urllib3==1.25.8 +wcwidth==0.1.8 +zipp==1.2.0