From 99f4477c77e0c3498c4856639630c809786d9b32 Mon Sep 17 00:00:00 2001 From: Dave Cowden Date: Sat, 24 May 2014 13:43:15 -0400 Subject: [PATCH] Fixed documentation errors --- README.md | 2 +- cadquery.egg-info/PKG-INFO | 122 +++++++++++++++++++++++++ cadquery.egg-info/SOURCES.txt | 28 ++++++ cadquery.egg-info/dependency_links.txt | 1 + cadquery.egg-info/not-zip-safe | 1 + cadquery.egg-info/top_level.txt | 2 + 6 files changed, 155 insertions(+), 1 deletion(-) create mode 100644 cadquery.egg-info/PKG-INFO create mode 100644 cadquery.egg-info/SOURCES.txt create mode 100644 cadquery.egg-info/dependency_links.txt create mode 100644 cadquery.egg-info/not-zip-safe create mode 100644 cadquery.egg-info/top_level.txt diff --git a/README.md b/README.md index f5649b1..2c26cd6 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,7 @@ Use these steps if you would like to write CadQuery scripts from inside of the F 3. use the Python version embedded with Freecad to set up cadquery, eg: cd "C:\Program Files\FreeCAD0.13\bin" - python "C:\Program Files\FreeCAD0.13\bin\cadquery-0.1.4/setup.py + python "C:\Program Files\FreeCAD0.13\bin\cadquery-0.1.4/setup.py install 4. copy generated binaries from FreeCAD0.13/bin/cadquery/cadquery into FreeCAD/Mod/Scripts diff --git a/cadquery.egg-info/PKG-INFO b/cadquery.egg-info/PKG-INFO new file mode 100644 index 0000000..e0fafbe --- /dev/null +++ b/cadquery.egg-info/PKG-INFO @@ -0,0 +1,122 @@ +Metadata-Version: 1.0 +Name: cadquery +Version: 0.1.5 +Summary: CadQuery is a parametric scripting language for creating and traversing CAD models +Home-page: https://github.com/dcowden/cadquery +Author: David Cowden +Author-email: dave.cowden@gmail.com +License: LGPL +Description: What is a CadQuery? + ======================================== + + CadQuery is an intuitive, easy-to-use python based language for building parametric 3D CAD models. CadQuery is for 3D CAD what jQuery is for javascript. Imagine selecting Faces of a 3d object the same way you select DOM objects with JQuery! + + CadQuery has several goals: + + * Build models with scripts that are as close as possible to how you'd describe the object to a human. + * Create parametric models that can be very easily customized by end users + * Output high quality CAD formats like STEP and AMF in addition to traditional STL + * Provide a non-proprietary, plain text model format that can be edited and executed with only a web browser + + Using CadQuery, you can write short, simple scripts that produce high quality CAD models. It is easy to make many different objects using a single script that can be customized. + + Why CadQuery instead of OpenSCAD? + ======================================== + + CadQuery is based on OpenCasCade. CadQuery shares many features with OpenSCAD, another open source, script based, parametric model generator. + + The primary advantage of OpenSCAD is the large number of already existing model libaries that exist already. So why not simply use OpenSCAD? + + CadQuery scripts have several key advantages over OpenSCAD: + + 1. **The scripts use a standard programming language**, python, and thus can benefit from the associated infrastructure. + This includes many standard libraries and IDEs + + 2. **More powerful CAD kernel** OpenCascade is much more powerful than CGAL. Features supported natively + by OCC include NURBS, splines, surface sewing, STL repair, STEP import/export, and other complex operations, + in addition to the standard CSG operations supported by CGAL + + 3. **Ability to import/export STEP** We think the ability to begin with a STEP model, created in a CAD package, + and then add parametric features is key. This is possible in OpenSCAD using STL, but STL is a lossy format + + 4. **Less Code and easier scripting** CadQuery scripts require less code to create most objects, because it is possible to locate + features based on the position of other features, workplanes, vertices, etc. + + 5. **Better Performance** CadQuery scripts can build STL, STEP, and AMF faster than OpenSCAD. + + License + ======== + + CadQuery is licensed under the terms of the LGPLv3. http://www.gnu.org/copyleft/lesser.html + + Where is the GUI? + ================== + + CadQuery does not provide a stand-alone gui yet, though this is one of the projects we hope to tackle. + + CadQuery provides the backbone of http://parametricparts.com, so the easiest way to see it in action is to review the samples and objects there. + + Installing + ============ + + 1. install FreeCAD, version 0.12 or greater for your platform. http://sourceforge.net/projects/free-cad/. + + 2. adjust your path if necessary. FreeCAD bundles a python interpreter, but you'll probably want to use your own, + preferably one that has virtualenv available. To use FreeCAD from any python interpreter, just append the FreeCAD + lib directory to your path. On (*Nix):: + + import sys + sys.path.append('/usr/lib/freecad/lib') + + or on Windows:: + + import sys + sys.path.append('/c/apps/FreeCAD/bin') + + *NOTE* FreeCAD on Windows will not work with python 2.7-- you must use pthon 2.6.X!!!! + + 3. install cadquery:: + + pip install cadquery + + 3. test your installation:: + + from cadquery import * + box = Workplane("XY").box(1,2,3) + exporters.toString(box,'STL') + + You're up and running! + + + + + Where does the name CadQuery come from? + ======================================== + + CadQuery is inspired by ( `jQuery `_ ), a popular framework that + revolutionized web development involving javascript. + + If you are familiar with how jQuery, you will probably recognize several jQuery features that CadQuery uses: + + * A fluent api to create clean, easy to read code + * Language features that make selection and iteration incredibly easy + * + * Ability to use the library along side other python libraries + * Clear and complete documentation, with plenty of samples. + + +Platform: any +Classifier: Development Status :: 3 - Alpha +Classifier: Intended Audience :: Developers +Classifier: Intended Audience :: End Users/Desktop +Classifier: Intended Audience :: Information Technology +Classifier: Intended Audience :: Science/Research +Classifier: Intended Audience :: System Administrators +Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3) +Classifier: Operating System :: POSIX +Classifier: Operating System :: MacOS +Classifier: Operating System :: Unix +Classifier: Programming Language :: Python +Classifier: Topic :: Software Development :: Libraries :: Python Modules +Classifier: Topic :: Internet +Classifier: Topic :: Scientific/Engineering diff --git a/cadquery.egg-info/SOURCES.txt b/cadquery.egg-info/SOURCES.txt new file mode 100644 index 0000000..2328c8b --- /dev/null +++ b/cadquery.egg-info/SOURCES.txt @@ -0,0 +1,28 @@ +MANIFEST.in +README.txt +setup.cfg +setup.py +cadquery/CQ.py +cadquery/__init__.py +cadquery/cq_directive.py +cadquery/selectors.py +cadquery/workplane.py +cadquery.egg-info/PKG-INFO +cadquery.egg-info/SOURCES.txt +cadquery.egg-info/dependency_links.txt +cadquery.egg-info/not-zip-safe +cadquery.egg-info/top_level.txt +cadquery/contrib/__init__.py +cadquery/freecad_impl/__init__.py +cadquery/freecad_impl/exporters.py +cadquery/freecad_impl/geom.py +cadquery/freecad_impl/shapes.py +cadquery/freecad_impl/verutil.py +cadquery/plugins/__init__.py +tests/TestCQSelectors.py +tests/TestCadObjects.py +tests/TestCadQuery.py +tests/TestExporters.py +tests/TestImports.py +tests/TestWorkplanes.py +tests/__init__.py \ No newline at end of file diff --git a/cadquery.egg-info/dependency_links.txt b/cadquery.egg-info/dependency_links.txt new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/cadquery.egg-info/dependency_links.txt @@ -0,0 +1 @@ + diff --git a/cadquery.egg-info/not-zip-safe b/cadquery.egg-info/not-zip-safe new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/cadquery.egg-info/not-zip-safe @@ -0,0 +1 @@ + diff --git a/cadquery.egg-info/top_level.txt b/cadquery.egg-info/top_level.txt new file mode 100644 index 0000000..2bbe7fc --- /dev/null +++ b/cadquery.egg-info/top_level.txt @@ -0,0 +1,2 @@ +cadquery +tests