Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 5a52725
Showing
16 changed files
with
584 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2018 Alex Barry | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
Pip4Blender | ||
=========== | ||
|
||
Overview | ||
-------- | ||
|
||
This is a Blender Add-on which enables support for using pip (the standard | ||
Python Package Manager) from within Blender. | ||
|
||
Blender utilizes a bundled Python implementation, which does not include pip. Because | ||
of this, it is actually quite difficult to install third-party libraries and packages | ||
into the Blender Python Implementation. Pip4Blender makes this just as easy as | ||
installing normal add-ons. | ||
|
||
Features | ||
-------- | ||
* Install Pip into the Blender Python installation from the Blender UI | ||
* Use pip to install specific libraries from the Blender UI | ||
* Import requirements.txt files from the Blender UI | ||
|
||
License | ||
------- | ||
|
||
PyAesel is licensed under the MIT license. | ||
For further details, please refer to the LICENSE file. | ||
|
||
Contact | ||
------- | ||
|
||
Stuck and need help? Have general questions about the application? Reach out to | ||
the developers at aostreetart9@gmail.com. | ||
|
||
If you believe that you have found a bug in Pip4Blender, or have an enhancement request, | ||
we encourage you to raise an issue on our `github page <https://github.com/AO-StreetArt/pip4blender>`__. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Minimal makefile for Sphinx documentation | ||
# | ||
|
||
# You can set these variables from the command line. | ||
SPHINXOPTS = | ||
SPHINXBUILD = sphinx-build | ||
SPHINXPROJ = Pip4Blender | ||
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) |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,227 @@ | ||
# -*- coding: utf-8 -*- | ||
# | ||
# Configuration file for the Sphinx documentation builder. | ||
# | ||
# This file does only contain a selection of the most common options. For a | ||
# full list see the documentation: | ||
# http://www.sphinx-doc.org/en/stable/config | ||
|
||
# -- Path setup -------------------------------------------------------------- | ||
|
||
# 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 sphinx_bootstrap_theme | ||
|
||
# -- Project information ----------------------------------------------------- | ||
|
||
project = 'Pip4Blender' | ||
copyright = '2018, AO Labs' | ||
author = 'AO Labs' | ||
|
||
# The short X.Y version | ||
version = '' | ||
# The full version, including alpha/beta/rc tags | ||
release = '1.0.0' | ||
|
||
|
||
# -- 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 = ['sphinxcontrib.httpdomain', 'sphinxcontrib.httpexample'] | ||
|
||
|
||
# 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' | ||
|
||
# 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 pattern also affects 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' | ||
|
||
|
||
# -- 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 = 'bootstrap' | ||
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() | ||
|
||
html_logo = "_static/images/Aesel_Icon_Alpha.png" | ||
|
||
# Theme options are theme-specific and customize the look and feel of a | ||
# theme further. | ||
html_theme_options = { | ||
# Navigation bar title. (Default: ``project`` value) | ||
'navbar_title': "Pip4Blender", | ||
|
||
# Tab name for entire site. (Default: "Site") | ||
'navbar_site_name': "Pip4Blender", | ||
|
||
# A list of tuples containing pages or urls to link to. | ||
# Valid tuples should be in the following forms: | ||
# (name, page) # a link to a page | ||
# (name, "/aa/bb", 1) # a link to an arbitrary relative url | ||
# (name, "http://example.com", True) # arbitrary absolute url | ||
# Note the "1" or "True" value above as the third argument to indicate | ||
# an arbitrary url. | ||
'navbar_links': [ | ||
("Install", "pages/install"), | ||
("Getting Started", "pages/quickstart"), | ||
("Developing with Pip4Blender", "pages/addon_dependencies"), | ||
], | ||
|
||
# Render the next and previous page links in navbar. (Default: true) | ||
'navbar_sidebarrel': True, | ||
|
||
# Render the current pages TOC in the navbar. (Default: true) | ||
'navbar_pagenav': True, | ||
|
||
# Tab name for the current pages TOC. (Default: "Page") | ||
'navbar_pagenav_name': "Page", | ||
|
||
# Global TOC depth for "site" navbar tab. (Default: 1) | ||
# Switching to -1 shows all levels. | ||
'globaltoc_depth': 2, | ||
|
||
# Include hidden TOCs in Site navbar? | ||
# | ||
# Note: If this is "false", you cannot have mixed ``:hidden:`` and | ||
# non-hidden ``toctree`` directives in the same page, or else the build | ||
# will break. | ||
# | ||
# Values: "true" (default) or "false" | ||
'globaltoc_includehidden': "true", | ||
|
||
# HTML navbar class (Default: "navbar") to attach to <div> element. | ||
# For black navbar, do "navbar navbar-inverse" | ||
'navbar_class': "navbar navbar-inverse", | ||
|
||
# Fix navigation bar to top of page? | ||
# Values: "true" (default) or "false" | ||
'navbar_fixed_top': "true", | ||
|
||
# Location of link to source. | ||
# Options are "nav" (default), "footer" or anything else to exclude. | ||
'source_link_position': "footer", | ||
|
||
# Bootswatch (http://bootswatch.com/) theme. | ||
# | ||
# Options are nothing (default) or the name of a valid theme | ||
# such as "cosmo" or "sandstone". | ||
# | ||
# The set of valid themes depend on the version of Bootstrap | ||
# that's used (the next config option). | ||
# | ||
# Currently, the supported themes are: | ||
# - Bootstrap 2: https://bootswatch.com/2 | ||
# - Bootstrap 3: https://bootswatch.com/3 | ||
'bootswatch_theme': "sandstone", | ||
|
||
# Choose Bootstrap version. | ||
# Values: "3" (default) or "2" (in quotes) | ||
'bootstrap_version': "3", | ||
} | ||
|
||
# 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'] | ||
|
||
# Custom sidebar templates, must be a dictionary that maps document names | ||
# to template names. | ||
# | ||
# The default sidebars (for documents that don't match any pattern) are | ||
# defined by theme itself. Builtin themes are using these templates by | ||
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', | ||
# 'searchbox.html']``. | ||
# | ||
# html_sidebars = {} | ||
|
||
|
||
# -- Options for HTMLHelp output --------------------------------------------- | ||
|
||
# Output file base name for HTML help builder. | ||
htmlhelp_basename = 'Pip4Blenderdoc' | ||
|
||
|
||
# -- 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, 'Pip4Blender.tex', 'Pip4Blender Documentation', | ||
'AO Labs', '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, 'pip4blender', 'Pip4Blender 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, 'Pip4Blender', 'Pip4Blender Documentation', | ||
author, 'Pip4Blender', 'One line description of project.', | ||
'Miscellaneous'), | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
.. _index: | ||
|
||
.. include:: ../README.rst | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:caption: Contents: | ||
|
||
pages/install.rst | ||
pages/quickstart.rst | ||
pages/addon_dependencies.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
@ECHO OFF | ||
|
||
pushd %~dp0 | ||
|
||
REM Command file for Sphinx documentation | ||
|
||
if "%SPHINXBUILD%" == "" ( | ||
set SPHINXBUILD=sphinx-build | ||
) | ||
set SOURCEDIR=. | ||
set BUILDDIR=_build | ||
set SPHINXPROJ=Pip4Blender | ||
|
||
if "%1" == "" goto help | ||
|
||
%SPHINXBUILD% >NUL 2>NUL | ||
if errorlevel 9009 ( | ||
echo. | ||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx | ||
echo.installed, then set the SPHINXBUILD environment variable to point | ||
echo.to the full path of the 'sphinx-build' executable. Alternatively you | ||
echo.may add the 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 |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
.. _addondeps: | ||
|
||
Developing with Pip4Blender | ||
=========================== | ||
|
||
Developers creating new Add-ons will benefit the most from pip4blender. During | ||
initial development, developers can install libraries as needed, one-by-one. This | ||
reduces the overall cost of development by promoting use of solid, well-tested, | ||
third-party libraries instead of the same code re-written over and over again. | ||
|
||
Once a developer is complete (enough) to release the add-on to the public, they | ||
can also distribute a requirements.txt file, which specifies the name and version | ||
of all dependent packages. | ||
|
||
Then, users can hit the 'Install Requirements File' button, which will open a | ||
filebrowser to select the requirements.txt file supplied by the developer. | ||
|
||
.. image:: _images/Install_ReqFile.png |
Oops, something went wrong.