Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Expand README

  • Loading branch information...
commit 2e2b82b4eb872301a383937da7ea23c8cff56522 1 parent 75bc087
@mwilliamson authored
Showing with 14 additions and 0 deletions.
  1. +14 −0 README.md
View
14 README.md
@@ -14,3 +14,17 @@ You can also point stickytape towards a Python binary that it should use sys.pat
from, for instance the Python binary inside a virtualenv:
```stickytape scripts/blah --python-binary _virtualenv/bin/python --output-file /tmp/blah-standalone```
+
+As you might expect with a program that munges source files, there are a few
+caveats:
+
+* Detection of imports is done using a fairly simple regex. For instance, things
+ will go horribly wrong if you use have two import statements on the same line
+ separated by a semi-colon. Similarly, imports using importlib won't be
+ detected.
+
+* Anything that relies on the specific location of files will probably no longer work. In
+ other words, `__file__` probably isn't all that useful.
+
+* Any files that aren't imported won't be included. Static data that might be
+ part of your project, such as other text files or images, won't be included.
Please sign in to comment.
Something went wrong with that request. Please try again.