Initial commit
Created the basic project structure.
This commit is contained in:
		
							
								
								
									
										21
									
								
								.editorconfig
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										21
									
								
								.editorconfig
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,21 @@ | ||||
| # http://editorconfig.org | ||||
|  | ||||
| root = true | ||||
|  | ||||
| [*] | ||||
| indent_style = space | ||||
| indent_size = 4 | ||||
| trim_trailing_whitespace = true | ||||
| insert_final_newline = true | ||||
| charset = utf-8 | ||||
| end_of_line = lf | ||||
|  | ||||
| [*.bat] | ||||
| indent_style = tab | ||||
| end_of_line = crlf | ||||
|  | ||||
| [LICENSE] | ||||
| insert_final_newline = false | ||||
|  | ||||
| [Makefile] | ||||
| indent_style = tab | ||||
							
								
								
									
										15
									
								
								.github/ISSUE_TEMPLATE.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								.github/ISSUE_TEMPLATE.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,15 @@ | ||||
| * FUSEionTranscode version: | ||||
| * Python version: | ||||
| * Operating System: | ||||
|  | ||||
| ### Description | ||||
|  | ||||
| Describe what you were trying to get done. | ||||
| Tell us what happened, what went wrong, and what you expected to happen. | ||||
|  | ||||
| ### What I Did | ||||
|  | ||||
| ``` | ||||
| Paste the command(s) you ran and the output. | ||||
| If there was a crash, please include the traceback here. | ||||
| ``` | ||||
							
								
								
									
										105
									
								
								.gitignore
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										105
									
								
								.gitignore
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,105 @@ | ||||
| # Byte-compiled / optimized / DLL files | ||||
| __pycache__/ | ||||
| *.py[cod] | ||||
| *$py.class | ||||
|  | ||||
| # C extensions | ||||
| *.so | ||||
|  | ||||
| # Distribution / packaging | ||||
| .Python | ||||
| env/ | ||||
| build/ | ||||
| develop-eggs/ | ||||
| dist/ | ||||
| downloads/ | ||||
| eggs/ | ||||
| .eggs/ | ||||
| lib/ | ||||
| lib64/ | ||||
| parts/ | ||||
| sdist/ | ||||
| var/ | ||||
| wheels/ | ||||
| *.egg-info/ | ||||
| .installed.cfg | ||||
| *.egg | ||||
|  | ||||
| # 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/ | ||||
| .coverage | ||||
| .coverage.* | ||||
| .cache | ||||
| nosetests.xml | ||||
| coverage.xml | ||||
| *.cover | ||||
| .hypothesis/ | ||||
| .pytest_cache/ | ||||
|  | ||||
| # Translations | ||||
| *.mo | ||||
| *.pot | ||||
|  | ||||
| # Django stuff: | ||||
| *.log | ||||
| local_settings.py | ||||
|  | ||||
| # Flask stuff: | ||||
| instance/ | ||||
| .webassets-cache | ||||
|  | ||||
| # Scrapy stuff: | ||||
| .scrapy | ||||
|  | ||||
| # Sphinx documentation | ||||
| docs/_build/ | ||||
|  | ||||
| # PyBuilder | ||||
| target/ | ||||
|  | ||||
| # Jupyter Notebook | ||||
| .ipynb_checkpoints | ||||
|  | ||||
| # pyenv | ||||
| .python-version | ||||
|  | ||||
| # celery beat schedule file | ||||
| celerybeat-schedule | ||||
|  | ||||
| # SageMath parsed files | ||||
| *.sage.py | ||||
|  | ||||
| # dotenv | ||||
| .env | ||||
|  | ||||
| # virtualenv | ||||
| .venv | ||||
| venv/ | ||||
| ENV/ | ||||
|  | ||||
| # Spyder project settings | ||||
| .spyderproject | ||||
| .spyproject | ||||
|  | ||||
| # Rope project settings | ||||
| .ropeproject | ||||
|  | ||||
| # mkdocs documentation | ||||
| /site | ||||
|  | ||||
| # mypy | ||||
| .mypy_cache/ | ||||
|  | ||||
| # IDE settings | ||||
| .vscode/ | ||||
							
								
								
									
										29
									
								
								.travis.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										29
									
								
								.travis.yml
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,29 @@ | ||||
| # Config file for automatic testing at travis-ci.com | ||||
|  | ||||
| language: python | ||||
| python: | ||||
|   - 3.8 | ||||
|   - 3.7 | ||||
|   - 3.6 | ||||
|   - 3.5 | ||||
|  | ||||
| # Command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors | ||||
| install: pip install -U tox-travis | ||||
|  | ||||
| # Command to run tests, e.g. python setup.py test | ||||
| script: tox | ||||
|  | ||||
| # Assuming you have installed the travis-ci CLI tool, after you | ||||
| # create the Github repo and add it to Travis, run the | ||||
| # following command to finish PyPI deployment setup: | ||||
| # $ travis encrypt --add deploy.password | ||||
| deploy: | ||||
|   provider: pypi | ||||
|   distributions: sdist bdist_wheel | ||||
|   user: Sticklyman1936 | ||||
|   password: | ||||
|     secure: PLEASE_REPLACE_ME | ||||
|   on: | ||||
|     tags: true | ||||
|     repo: Sticklyman1936/fuseiontranscode | ||||
|     python: 3.8 | ||||
							
								
								
									
										13
									
								
								AUTHORS.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								AUTHORS.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,13 @@ | ||||
| ======= | ||||
| Credits | ||||
| ======= | ||||
|  | ||||
| Development Lead | ||||
| ---------------- | ||||
|  | ||||
| * Sascha Bischoff <sascha.bischoff@googlemail.com> | ||||
|  | ||||
| Contributors | ||||
| ------------ | ||||
|  | ||||
| None yet. Why not be the first? | ||||
							
								
								
									
										128
									
								
								CONTRIBUTING.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										128
									
								
								CONTRIBUTING.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,128 @@ | ||||
| .. highlight:: shell | ||||
|  | ||||
| ============ | ||||
| Contributing | ||||
| ============ | ||||
|  | ||||
| Contributions are welcome, and they are greatly appreciated! Every little bit | ||||
| helps, and credit will always be given. | ||||
|  | ||||
| You can contribute in many ways: | ||||
|  | ||||
| Types of Contributions | ||||
| ---------------------- | ||||
|  | ||||
| Report Bugs | ||||
| ~~~~~~~~~~~ | ||||
|  | ||||
| Report bugs at https://github.com/Sticklyman1936/fuseiontranscode/issues. | ||||
|  | ||||
| If you are reporting a bug, please include: | ||||
|  | ||||
| * Your operating system name and version. | ||||
| * Any details about your local setup that might be helpful in troubleshooting. | ||||
| * Detailed steps to reproduce the bug. | ||||
|  | ||||
| Fix Bugs | ||||
| ~~~~~~~~ | ||||
|  | ||||
| Look through the GitHub issues for bugs. Anything tagged with "bug" and "help | ||||
| wanted" is open to whoever wants to implement it. | ||||
|  | ||||
| Implement Features | ||||
| ~~~~~~~~~~~~~~~~~~ | ||||
|  | ||||
| Look through the GitHub issues for features. Anything tagged with "enhancement" | ||||
| and "help wanted" is open to whoever wants to implement it. | ||||
|  | ||||
| Write Documentation | ||||
| ~~~~~~~~~~~~~~~~~~~ | ||||
|  | ||||
| FUSEionTranscode could always use more documentation, whether as part of the | ||||
| official FUSEionTranscode docs, in docstrings, or even on the web in blog posts, | ||||
| articles, and such. | ||||
|  | ||||
| Submit Feedback | ||||
| ~~~~~~~~~~~~~~~ | ||||
|  | ||||
| The best way to send feedback is to file an issue at https://github.com/Sticklyman1936/fuseiontranscode/issues. | ||||
|  | ||||
| If you are proposing a feature: | ||||
|  | ||||
| * Explain in detail how it would work. | ||||
| * Keep the scope as narrow as possible, to make it easier to implement. | ||||
| * Remember that this is a volunteer-driven project, and that contributions | ||||
|   are welcome :) | ||||
|  | ||||
| Get Started! | ||||
| ------------ | ||||
|  | ||||
| Ready to contribute? Here's how to set up `fuseiontranscode` for local development. | ||||
|  | ||||
| 1. Fork the `fuseiontranscode` repo on GitHub. | ||||
| 2. Clone your fork locally:: | ||||
|  | ||||
|     $ git clone git@github.com:your_name_here/fuseiontranscode.git | ||||
|  | ||||
| 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:: | ||||
|  | ||||
|     $ mkvirtualenv fuseiontranscode | ||||
|     $ cd fuseiontranscode/ | ||||
|     $ python setup.py develop | ||||
|  | ||||
| 4. Create a branch for local development:: | ||||
|  | ||||
|     $ git checkout -b name-of-your-bugfix-or-feature | ||||
|  | ||||
|    Now you can make your changes locally. | ||||
|  | ||||
| 5. When you're done making changes, check that your changes pass flake8 and the | ||||
|    tests, including testing other Python versions with tox:: | ||||
|  | ||||
|     $ flake8 fuseiontranscode tests | ||||
|     $ python setup.py test or pytest | ||||
|     $ tox | ||||
|  | ||||
|    To get flake8 and tox, just pip install them into your virtualenv. | ||||
|  | ||||
| 6. Commit your changes and push your branch to GitHub:: | ||||
|  | ||||
|     $ git add . | ||||
|     $ git commit -m "Your detailed description of your changes." | ||||
|     $ git push origin name-of-your-bugfix-or-feature | ||||
|  | ||||
| 7. Submit a pull request through the GitHub website. | ||||
|  | ||||
| Pull Request Guidelines | ||||
| ----------------------- | ||||
|  | ||||
| Before you submit a pull request, check that it meets these guidelines: | ||||
|  | ||||
| 1. The pull request should include tests. | ||||
| 2. If the pull request adds functionality, the docs should be updated. Put | ||||
|    your new functionality into a function with a docstring, and add the | ||||
|    feature to the list in README.rst. | ||||
| 3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check | ||||
|    https://travis-ci.com/Sticklyman1936/fuseiontranscode/pull_requests | ||||
|    and make sure that the tests pass for all supported Python versions. | ||||
|  | ||||
| Tips | ||||
| ---- | ||||
|  | ||||
| To run a subset of tests:: | ||||
|  | ||||
| $ pytest tests.test_fuseiontranscode | ||||
|  | ||||
|  | ||||
| Deploying | ||||
| --------- | ||||
|  | ||||
| A reminder for the maintainers on how to deploy. | ||||
| Make sure all your changes are committed (including an entry in HISTORY.rst). | ||||
| Then run:: | ||||
|  | ||||
| $ bump2version patch # possible: major / minor / patch | ||||
| $ git push | ||||
| $ git push --tags | ||||
|  | ||||
| Travis will then deploy to PyPI if tests pass. | ||||
							
								
								
									
										8
									
								
								HISTORY.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										8
									
								
								HISTORY.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,8 @@ | ||||
| ======= | ||||
| History | ||||
| ======= | ||||
|  | ||||
| 0.1.0 (2021-03-14) | ||||
| ------------------ | ||||
|  | ||||
| * First release on PyPI. | ||||
							
								
								
									
										16
									
								
								LICENSE
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										16
									
								
								LICENSE
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,16 @@ | ||||
| Apache Software License 2.0 | ||||
|  | ||||
| Copyright (c) 2021, Sascha Bischoff | ||||
|  | ||||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||||
| you may not use this file except in compliance with the License. | ||||
| You may obtain a copy of the License at | ||||
|  | ||||
| http://www.apache.org/licenses/LICENSE-2.0 | ||||
|  | ||||
| Unless required by applicable law or agreed to in writing, software | ||||
| distributed under the License is distributed on an "AS IS" BASIS, | ||||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||||
| See the License for the specific language governing permissions and | ||||
| limitations under the License. | ||||
|  | ||||
							
								
								
									
										11
									
								
								MANIFEST.in
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										11
									
								
								MANIFEST.in
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,11 @@ | ||||
| include AUTHORS.rst | ||||
| include CONTRIBUTING.rst | ||||
| include HISTORY.rst | ||||
| include LICENSE | ||||
| include README.rst | ||||
|  | ||||
| recursive-include tests * | ||||
| recursive-exclude * __pycache__ | ||||
| recursive-exclude * *.py[co] | ||||
|  | ||||
| recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif | ||||
							
								
								
									
										85
									
								
								Makefile
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										85
									
								
								Makefile
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,85 @@ | ||||
| .PHONY: clean clean-test clean-pyc clean-build docs help | ||||
| .DEFAULT_GOAL := help | ||||
|  | ||||
| define BROWSER_PYSCRIPT | ||||
| import os, webbrowser, sys | ||||
|  | ||||
| from urllib.request import pathname2url | ||||
|  | ||||
| webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1]))) | ||||
| endef | ||||
| export BROWSER_PYSCRIPT | ||||
|  | ||||
| define PRINT_HELP_PYSCRIPT | ||||
| import re, sys | ||||
|  | ||||
| for line in sys.stdin: | ||||
| 	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line) | ||||
| 	if match: | ||||
| 		target, help = match.groups() | ||||
| 		print("%-20s %s" % (target, help)) | ||||
| endef | ||||
| export PRINT_HELP_PYSCRIPT | ||||
|  | ||||
| BROWSER := python -c "$$BROWSER_PYSCRIPT" | ||||
|  | ||||
| help: | ||||
| 	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST) | ||||
|  | ||||
| clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts | ||||
|  | ||||
| clean-build: ## remove build artifacts | ||||
| 	rm -fr build/ | ||||
| 	rm -fr dist/ | ||||
| 	rm -fr .eggs/ | ||||
| 	find . -name '*.egg-info' -exec rm -fr {} + | ||||
| 	find . -name '*.egg' -exec rm -f {} + | ||||
|  | ||||
| clean-pyc: ## remove Python file artifacts | ||||
| 	find . -name '*.pyc' -exec rm -f {} + | ||||
| 	find . -name '*.pyo' -exec rm -f {} + | ||||
| 	find . -name '*~' -exec rm -f {} + | ||||
| 	find . -name '__pycache__' -exec rm -fr {} + | ||||
|  | ||||
| clean-test: ## remove test and coverage artifacts | ||||
| 	rm -fr .tox/ | ||||
| 	rm -f .coverage | ||||
| 	rm -fr htmlcov/ | ||||
| 	rm -fr .pytest_cache | ||||
|  | ||||
| lint: ## check style with flake8 | ||||
| 	flake8 fuseiontranscode tests | ||||
|  | ||||
| test: ## run tests quickly with the default Python | ||||
| 	pytest | ||||
|  | ||||
| test-all: ## run tests on every Python version with tox | ||||
| 	tox | ||||
|  | ||||
| coverage: ## check code coverage quickly with the default Python | ||||
| 	coverage run --source fuseiontranscode -m pytest | ||||
| 	coverage report -m | ||||
| 	coverage html | ||||
| 	$(BROWSER) htmlcov/index.html | ||||
|  | ||||
| docs: ## generate Sphinx HTML documentation, including API docs | ||||
| 	rm -f docs/fuseiontranscode.rst | ||||
| 	rm -f docs/modules.rst | ||||
| 	sphinx-apidoc -o docs/ fuseiontranscode | ||||
| 	$(MAKE) -C docs clean | ||||
| 	$(MAKE) -C docs html | ||||
| 	$(BROWSER) docs/_build/html/index.html | ||||
|  | ||||
| servedocs: docs ## compile the docs watching for changes | ||||
| 	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D . | ||||
|  | ||||
| release: dist ## package and upload a release | ||||
| 	twine upload dist/* | ||||
|  | ||||
| dist: clean ## builds source and wheel package | ||||
| 	python setup.py sdist | ||||
| 	python setup.py bdist_wheel | ||||
| 	ls -l dist | ||||
|  | ||||
| install: clean ## install the package to the active Python's site-packages | ||||
| 	python setup.py install | ||||
							
								
								
									
										37
									
								
								README.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										37
									
								
								README.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,37 @@ | ||||
| ================ | ||||
| FUSEionTranscode | ||||
| ================ | ||||
|  | ||||
|  | ||||
| .. image:: https://img.shields.io/pypi/v/fuseiontranscode.svg | ||||
|         :target: https://pypi.python.org/pypi/fuseiontranscode | ||||
|  | ||||
| .. image:: https://img.shields.io/travis/Sticklyman1936/fuseiontranscode.svg | ||||
|         :target: https://travis-ci.com/Sticklyman1936/fuseiontranscode | ||||
|  | ||||
| .. image:: https://readthedocs.org/projects/fuseiontranscode/badge/?version=latest | ||||
|         :target: https://fuseiontranscode.readthedocs.io/en/latest/?version=latest | ||||
|         :alt: Documentation Status | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| A FUSE-based filesystem which can transcode files on the fly. | ||||
|  | ||||
|  | ||||
| * Free software: Apache Software License 2.0 | ||||
| * Documentation: https://fuseiontranscode.readthedocs.io. | ||||
|  | ||||
|  | ||||
| Features | ||||
| -------- | ||||
|  | ||||
| * TODO | ||||
|  | ||||
| Credits | ||||
| ------- | ||||
|  | ||||
| This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template. | ||||
|  | ||||
| .. _Cookiecutter: https://github.com/audreyr/cookiecutter | ||||
| .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage | ||||
							
								
								
									
										20
									
								
								docs/Makefile
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										20
									
								
								docs/Makefile
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,20 @@ | ||||
| # Minimal makefile for Sphinx documentation | ||||
| # | ||||
|  | ||||
| # You can set these variables from the command line. | ||||
| SPHINXOPTS    = | ||||
| SPHINXBUILD   = python -msphinx | ||||
| SPHINXPROJ    = fuseiontranscode | ||||
| SOURCEDIR     = . | ||||
| BUILDDIR      = _build | ||||
|  | ||||
| # Put it first so that "make" without argument is like "make help". | ||||
| help: | ||||
| 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||||
|  | ||||
| .PHONY: help Makefile | ||||
|  | ||||
| # Catch-all target: route all unknown targets to Sphinx using the new | ||||
| # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS). | ||||
| %: Makefile | ||||
| 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||||
							
								
								
									
										1
									
								
								docs/authors.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								docs/authors.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1 @@ | ||||
| .. include:: ../AUTHORS.rst | ||||
							
								
								
									
										162
									
								
								docs/conf.py
									
									
									
									
									
										Executable file
									
								
							
							
						
						
									
										162
									
								
								docs/conf.py
									
									
									
									
									
										Executable file
									
								
							| @@ -0,0 +1,162 @@ | ||||
| #!/usr/bin/env python | ||||
| # | ||||
| # fuseiontranscode documentation build configuration file, created by | ||||
| # sphinx-quickstart on Fri Jun  9 13:47:02 2017. | ||||
| # | ||||
| # This file is execfile()d with the current directory set to its | ||||
| # containing dir. | ||||
| # | ||||
| # Note that not all possible configuration values are present in this | ||||
| # autogenerated file. | ||||
| # | ||||
| # All configuration values have a default; values that are commented out | ||||
| # serve to show the default. | ||||
|  | ||||
| # If extensions (or modules to document with autodoc) are in another | ||||
| # directory, add these directories to sys.path here. If the directory is | ||||
| # relative to the documentation root, use os.path.abspath to make it | ||||
| # absolute, like shown here. | ||||
| # | ||||
| import os | ||||
| import sys | ||||
| sys.path.insert(0, os.path.abspath('..')) | ||||
|  | ||||
| import fuseiontranscode | ||||
|  | ||||
| # -- General configuration --------------------------------------------- | ||||
|  | ||||
| # If your documentation needs a minimal Sphinx version, state it here. | ||||
| # | ||||
| # needs_sphinx = '1.0' | ||||
|  | ||||
| # Add any Sphinx extension module names here, as strings. They can be | ||||
| # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | ||||
| extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] | ||||
|  | ||||
| # Add any paths that contain templates here, relative to this directory. | ||||
| templates_path = ['_templates'] | ||||
|  | ||||
| # The suffix(es) of source filenames. | ||||
| # You can specify multiple suffix as a list of string: | ||||
| # | ||||
| # source_suffix = ['.rst', '.md'] | ||||
| source_suffix = '.rst' | ||||
|  | ||||
| # The master toctree document. | ||||
| master_doc = 'index' | ||||
|  | ||||
| # General information about the project. | ||||
| project = 'FUSEionTranscode' | ||||
| copyright = "2021, Sascha Bischoff" | ||||
| author = "Sascha Bischoff" | ||||
|  | ||||
| # The version info for the project you're documenting, acts as replacement | ||||
| # for |version| and |release|, also used in various other places throughout | ||||
| # the built documents. | ||||
| # | ||||
| # The short X.Y version. | ||||
| version = fuseiontranscode.__version__ | ||||
| # The full version, including alpha/beta/rc tags. | ||||
| release = fuseiontranscode.__version__ | ||||
|  | ||||
| # The language for content autogenerated by Sphinx. Refer to documentation | ||||
| # for a list of supported languages. | ||||
| # | ||||
| # This is also used if you do content translation via gettext catalogs. | ||||
| # Usually you set "language" from the command line for these cases. | ||||
| language = None | ||||
|  | ||||
| # List of patterns, relative to source directory, that match files and | ||||
| # directories to ignore when looking for source files. | ||||
| # This patterns also effect to html_static_path and html_extra_path | ||||
| exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] | ||||
|  | ||||
| # The name of the Pygments (syntax highlighting) style to use. | ||||
| pygments_style = 'sphinx' | ||||
|  | ||||
| # If true, `todo` and `todoList` produce output, else they produce nothing. | ||||
| todo_include_todos = False | ||||
|  | ||||
|  | ||||
| # -- Options for HTML output ------------------------------------------- | ||||
|  | ||||
| # The theme to use for HTML and HTML Help pages.  See the documentation for | ||||
| # a list of builtin themes. | ||||
| # | ||||
| html_theme = 'alabaster' | ||||
|  | ||||
| # Theme options are theme-specific and customize the look and feel of a | ||||
| # theme further.  For a list of options available for each theme, see the | ||||
| # documentation. | ||||
| # | ||||
| # html_theme_options = {} | ||||
|  | ||||
| # Add any paths that contain custom static files (such as style sheets) here, | ||||
| # relative to this directory. They are copied after the builtin static files, | ||||
| # so a file named "default.css" will overwrite the builtin "default.css". | ||||
| html_static_path = ['_static'] | ||||
|  | ||||
|  | ||||
| # -- Options for HTMLHelp output --------------------------------------- | ||||
|  | ||||
| # Output file base name for HTML help builder. | ||||
| htmlhelp_basename = 'fuseiontranscodedoc' | ||||
|  | ||||
|  | ||||
| # -- Options for LaTeX output ------------------------------------------ | ||||
|  | ||||
| latex_elements = { | ||||
|     # The paper size ('letterpaper' or 'a4paper'). | ||||
|     # | ||||
|     # 'papersize': 'letterpaper', | ||||
|  | ||||
|     # The font size ('10pt', '11pt' or '12pt'). | ||||
|     # | ||||
|     # 'pointsize': '10pt', | ||||
|  | ||||
|     # Additional stuff for the LaTeX preamble. | ||||
|     # | ||||
|     # 'preamble': '', | ||||
|  | ||||
|     # Latex figure (float) alignment | ||||
|     # | ||||
|     # 'figure_align': 'htbp', | ||||
| } | ||||
|  | ||||
| # Grouping the document tree into LaTeX files. List of tuples | ||||
| # (source start file, target name, title, author, documentclass | ||||
| # [howto, manual, or own class]). | ||||
| latex_documents = [ | ||||
|     (master_doc, 'fuseiontranscode.tex', | ||||
|      'FUSEionTranscode Documentation', | ||||
|      'Sascha Bischoff', 'manual'), | ||||
| ] | ||||
|  | ||||
|  | ||||
| # -- Options for manual page output ------------------------------------ | ||||
|  | ||||
| # One entry per manual page. List of tuples | ||||
| # (source start file, name, description, authors, manual section). | ||||
| man_pages = [ | ||||
|     (master_doc, 'fuseiontranscode', | ||||
|      'FUSEionTranscode Documentation', | ||||
|      [author], 1) | ||||
| ] | ||||
|  | ||||
|  | ||||
| # -- Options for Texinfo output ---------------------------------------- | ||||
|  | ||||
| # Grouping the document tree into Texinfo files. List of tuples | ||||
| # (source start file, target name, title, author, | ||||
| #  dir menu entry, description, category) | ||||
| texinfo_documents = [ | ||||
|     (master_doc, 'fuseiontranscode', | ||||
|      'FUSEionTranscode Documentation', | ||||
|      author, | ||||
|      'fuseiontranscode', | ||||
|      'One line description of project.', | ||||
|      'Miscellaneous'), | ||||
| ] | ||||
|  | ||||
|  | ||||
|  | ||||
							
								
								
									
										1
									
								
								docs/contributing.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								docs/contributing.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1 @@ | ||||
| .. include:: ../CONTRIBUTING.rst | ||||
							
								
								
									
										1
									
								
								docs/history.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								docs/history.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1 @@ | ||||
| .. include:: ../HISTORY.rst | ||||
							
								
								
									
										20
									
								
								docs/index.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										20
									
								
								docs/index.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,20 @@ | ||||
| Welcome to FUSEionTranscode's documentation! | ||||
| ====================================== | ||||
|  | ||||
| .. toctree:: | ||||
|    :maxdepth: 2 | ||||
|    :caption: Contents: | ||||
|  | ||||
|    readme | ||||
|    installation | ||||
|    usage | ||||
|    modules | ||||
|    contributing | ||||
|    authors | ||||
|    history | ||||
|  | ||||
| Indices and tables | ||||
| ================== | ||||
| * :ref:`genindex` | ||||
| * :ref:`modindex` | ||||
| * :ref:`search` | ||||
							
								
								
									
										51
									
								
								docs/installation.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										51
									
								
								docs/installation.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,51 @@ | ||||
| .. highlight:: shell | ||||
|  | ||||
| ============ | ||||
| Installation | ||||
| ============ | ||||
|  | ||||
|  | ||||
| Stable release | ||||
| -------------- | ||||
|  | ||||
| To install FUSEionTranscode, run this command in your terminal: | ||||
|  | ||||
| .. code-block:: console | ||||
|  | ||||
|     $ pip install fuseiontranscode | ||||
|  | ||||
| This is the preferred method to install FUSEionTranscode, as it will always install the most recent stable release. | ||||
|  | ||||
| If you don't have `pip`_ installed, this `Python installation guide`_ can guide | ||||
| you through the process. | ||||
|  | ||||
| .. _pip: https://pip.pypa.io | ||||
| .. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/ | ||||
|  | ||||
|  | ||||
| From sources | ||||
| ------------ | ||||
|  | ||||
| The sources for FUSEionTranscode can be downloaded from the `Github repo`_. | ||||
|  | ||||
| You can either clone the public repository: | ||||
|  | ||||
| .. code-block:: console | ||||
|  | ||||
|     $ git clone git://github.com/Sticklyman1936/fuseiontranscode | ||||
|  | ||||
| Or download the `tarball`_: | ||||
|  | ||||
| .. code-block:: console | ||||
|  | ||||
|     $ curl -OJL https://github.com/Sticklyman1936/fuseiontranscode/tarball/master | ||||
|  | ||||
| Once you have a copy of the source, you can install it with: | ||||
|  | ||||
| .. code-block:: console | ||||
|  | ||||
|     $ python setup.py install | ||||
|  | ||||
|  | ||||
| .. _Github repo: https://github.com/Sticklyman1936/fuseiontranscode | ||||
| .. _tarball: https://github.com/Sticklyman1936/fuseiontranscode/tarball/master | ||||
							
								
								
									
										36
									
								
								docs/make.bat
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										36
									
								
								docs/make.bat
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,36 @@ | ||||
| @ECHO OFF | ||||
|  | ||||
| pushd %~dp0 | ||||
|  | ||||
| REM Command file for Sphinx documentation | ||||
|  | ||||
| if "%SPHINXBUILD%" == "" ( | ||||
| 	set SPHINXBUILD=python -msphinx | ||||
| ) | ||||
| set SOURCEDIR=. | ||||
| set BUILDDIR=_build | ||||
| set SPHINXPROJ=fuseiontranscode | ||||
|  | ||||
| if "%1" == "" goto help | ||||
|  | ||||
| %SPHINXBUILD% >NUL 2>NUL | ||||
| if errorlevel 9009 ( | ||||
| 	echo. | ||||
| 	echo.The Sphinx module was not found. Make sure you have Sphinx installed, | ||||
| 	echo.then set the SPHINXBUILD environment variable to point to the full | ||||
| 	echo.path of the 'sphinx-build' executable. Alternatively you may add the | ||||
| 	echo.Sphinx directory to PATH. | ||||
| 	echo. | ||||
| 	echo.If you don't have Sphinx installed, grab it from | ||||
| 	echo.http://sphinx-doc.org/ | ||||
| 	exit /b 1 | ||||
| ) | ||||
|  | ||||
| %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% | ||||
| goto end | ||||
|  | ||||
| :help | ||||
| %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% | ||||
|  | ||||
| :end | ||||
| popd | ||||
							
								
								
									
										1
									
								
								docs/readme.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								docs/readme.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1 @@ | ||||
| .. include:: ../README.rst | ||||
							
								
								
									
										7
									
								
								docs/usage.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										7
									
								
								docs/usage.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,7 @@ | ||||
| ===== | ||||
| Usage | ||||
| ===== | ||||
|  | ||||
| To use FUSEionTranscode in a project:: | ||||
|  | ||||
|     import fuseiontranscode | ||||
							
								
								
									
										5
									
								
								fuseiontranscode/__init__.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										5
									
								
								fuseiontranscode/__init__.py
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,5 @@ | ||||
| """Top-level package for FUSEionTranscode.""" | ||||
|  | ||||
| __author__ = """Sascha Bischoff""" | ||||
| __email__ = 'sascha.bischoff@googlemail.com' | ||||
| __version__ = '0.1.0' | ||||
							
								
								
									
										19
									
								
								fuseiontranscode/cli.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										19
									
								
								fuseiontranscode/cli.py
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,19 @@ | ||||
| """Console script for fuseiontranscode.""" | ||||
| import argparse | ||||
| import sys | ||||
|  | ||||
|  | ||||
| def main(): | ||||
|     """Console script for fuseiontranscode.""" | ||||
|     parser = argparse.ArgumentParser() | ||||
|     parser.add_argument('_', nargs='*') | ||||
|     args = parser.parse_args() | ||||
|  | ||||
|     print("Arguments: " + str(args._)) | ||||
|     print("Replace this message by putting your code into " | ||||
|           "fuseiontranscode.cli.main") | ||||
|     return 0 | ||||
|  | ||||
|  | ||||
| if __name__ == "__main__": | ||||
|     sys.exit(main())  # pragma: no cover | ||||
							
								
								
									
										1
									
								
								fuseiontranscode/fuseiontranscode.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								fuseiontranscode/fuseiontranscode.py
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1 @@ | ||||
| """Main module.""" | ||||
							
								
								
									
										12
									
								
								requirements_dev.txt
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										12
									
								
								requirements_dev.txt
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,12 @@ | ||||
| pip==19.2.3 | ||||
| bump2version==0.5.11 | ||||
| wheel==0.33.6 | ||||
| watchdog==0.9.0 | ||||
| flake8==3.7.8 | ||||
| tox==3.14.0 | ||||
| coverage==4.5.4 | ||||
| Sphinx==1.8.5 | ||||
| twine==1.14.0 | ||||
|  | ||||
| pytest==4.6.5 | ||||
| pytest-runner==5.1 | ||||
							
								
								
									
										26
									
								
								setup.cfg
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										26
									
								
								setup.cfg
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,26 @@ | ||||
| [bumpversion] | ||||
| current_version = 0.1.0 | ||||
| commit = True | ||||
| tag = True | ||||
|  | ||||
| [bumpversion:file:setup.py] | ||||
| search = version='{current_version}' | ||||
| replace = version='{new_version}' | ||||
|  | ||||
| [bumpversion:file:fuseiontranscode/__init__.py] | ||||
| search = __version__ = '{current_version}' | ||||
| replace = __version__ = '{new_version}' | ||||
|  | ||||
| [bdist_wheel] | ||||
| universal = 1 | ||||
|  | ||||
| [flake8] | ||||
| exclude = docs | ||||
|  | ||||
| [aliases] | ||||
| # Define setup.py command aliases here | ||||
| test = pytest | ||||
|  | ||||
| [tool:pytest] | ||||
| collect_ignore = ['setup.py'] | ||||
|  | ||||
							
								
								
									
										53
									
								
								setup.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										53
									
								
								setup.py
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,53 @@ | ||||
| #!/usr/bin/env python | ||||
|  | ||||
| """The setup script.""" | ||||
|  | ||||
| from setuptools import setup, find_packages | ||||
|  | ||||
| with open('README.rst') as readme_file: | ||||
|     readme = readme_file.read() | ||||
|  | ||||
| with open('HISTORY.rst') as history_file: | ||||
|     history = history_file.read() | ||||
|  | ||||
| requirements = [ ] | ||||
|  | ||||
| setup_requirements = ['pytest-runner', ] | ||||
|  | ||||
| test_requirements = ['pytest>=3', ] | ||||
|  | ||||
| setup( | ||||
|     author="Sascha Bischoff", | ||||
|     author_email='sascha.bischoff@googlemail.com', | ||||
|     python_requires='>=3.5', | ||||
|     classifiers=[ | ||||
|         'Development Status :: 2 - Pre-Alpha', | ||||
|         'Intended Audience :: Developers', | ||||
|         'License :: OSI Approved :: Apache Software License', | ||||
|         'Natural Language :: English', | ||||
|         'Programming Language :: Python :: 3', | ||||
|         'Programming Language :: Python :: 3.5', | ||||
|         'Programming Language :: Python :: 3.6', | ||||
|         'Programming Language :: Python :: 3.7', | ||||
|         'Programming Language :: Python :: 3.8', | ||||
|     ], | ||||
|     description="A FUSE-based filesystem which can transcode files on the fly.", | ||||
|     entry_points={ | ||||
|         'console_scripts': [ | ||||
|             'fuseiontranscode=fuseiontranscode.cli:main', | ||||
|         ], | ||||
|     }, | ||||
|     install_requires=requirements, | ||||
|     license="Apache Software License 2.0", | ||||
|     long_description=readme + '\n\n' + history, | ||||
|     include_package_data=True, | ||||
|     keywords='fuseiontranscode', | ||||
|     name='fuseiontranscode', | ||||
|     packages=find_packages(include=['fuseiontranscode', 'fuseiontranscode.*']), | ||||
|     setup_requires=setup_requirements, | ||||
|     test_suite='tests', | ||||
|     tests_require=test_requirements, | ||||
|     url='https://github.com/Sticklyman1936/fuseiontranscode', | ||||
|     version='0.1.0', | ||||
|     zip_safe=False, | ||||
| ) | ||||
							
								
								
									
										1
									
								
								tests/__init__.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								tests/__init__.py
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1 @@ | ||||
| """Unit test package for fuseiontranscode.""" | ||||
							
								
								
									
										24
									
								
								tests/test_fuseiontranscode.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										24
									
								
								tests/test_fuseiontranscode.py
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,24 @@ | ||||
| #!/usr/bin/env python | ||||
|  | ||||
| """Tests for `fuseiontranscode` package.""" | ||||
|  | ||||
| import pytest | ||||
|  | ||||
|  | ||||
| from fuseiontranscode import fuseiontranscode | ||||
|  | ||||
|  | ||||
| @pytest.fixture | ||||
| def response(): | ||||
|     """Sample pytest fixture. | ||||
|  | ||||
|     See more at: http://doc.pytest.org/en/latest/fixture.html | ||||
|     """ | ||||
|     # import requests | ||||
|     # return requests.get('https://github.com/audreyr/cookiecutter-pypackage') | ||||
|  | ||||
|  | ||||
| def test_content(response): | ||||
|     """Sample pytest test function with the pytest fixture as an argument.""" | ||||
|     # from bs4 import BeautifulSoup | ||||
|     # assert 'GitHub' in BeautifulSoup(response.content).title.string | ||||
							
								
								
									
										27
									
								
								tox.ini
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										27
									
								
								tox.ini
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,27 @@ | ||||
| [tox] | ||||
| envlist = py35, py36, py37, py38, flake8 | ||||
|  | ||||
| [travis] | ||||
| python = | ||||
|     3.8: py38 | ||||
|     3.7: py37 | ||||
|     3.6: py36 | ||||
|     3.5: py35 | ||||
|  | ||||
| [testenv:flake8] | ||||
| basepython = python | ||||
| deps = flake8 | ||||
| commands = flake8 fuseiontranscode tests | ||||
|  | ||||
| [testenv] | ||||
| setenv = | ||||
|     PYTHONPATH = {toxinidir} | ||||
| deps = | ||||
|     -r{toxinidir}/requirements_dev.txt | ||||
| ; If you want to make tox run the tests with the same versions, create a | ||||
| ; requirements.txt with the pinned versions and uncomment the following line: | ||||
| ;     -r{toxinidir}/requirements.txt | ||||
| commands = | ||||
|     pip install -U pip | ||||
|     pytest --basetemp={envtmpdir} | ||||
|  | ||||
		Reference in New Issue
	
	Block a user