[renpy-distribute-tools] Do stuff

UnscriptedVN · Jan 4, 2020 · dc770a8 · dc770a8
1 parent 4dbd877
commit dc770a8
Show file tree

Hide file tree

Showing 14 changed files with 1,190 additions and 61 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,23 @@
+# Ren'Py Distribution Tools
+
+A set of tools to make Ren'Py distribution less of a pain in the arse.
+
+## Add to Poetry
+
+Run the following to add this module to your Poetry project:
+
+```
+poetry add --dev "git+https://github.com/alicerunsonfedora/renpy-distribute-tools.git#v0.2.2"
+```
+
+Or, in your `pyproject.toml` in `[tool.poetry.dev-dependencies]`:
+
+```toml
+renpy-distribute-tools = { git = "https://github.com/alicerunsonfedora/renpy-distribute-tools.git", rev = "v0.2.2" }
+```
+
+Then run `poetry update`.
+
+## Usage
+
+See the [documentation](https://alicerunsonfedora.github.io/renpy-distribute-tools) for more info.
diff --git a/README.rst b/README.rst
diff --git a/docs/apple.html b/docs/apple.html
diff --git a/docs/fixed_zipfile.html b/docs/fixed_zipfile.html
@@ -0,0 +1,222 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
+<meta name="generator" content="pdoc 0.7.2" />
+<title>renpy_distribute_tools.fixed_zipfile API documentation</title>
+<meta name="description" content="This module contains a customized version of the `ZipFile` object
+to properly handle extraction of macOS apps so that permissions aren&#39;t
+stripped." />
+<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
+<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
+<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
+<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>renpy_distribute_tools.fixed_zipfile</code></h1>
+</header>
+<section id="section-intro">
+<p>This module contains a customized version of the <code>ZipFile</code> object
+to properly handle extraction of macOS apps so that permissions aren't
+stripped.</p>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">&#34;&#34;&#34;
+    This module contains a customized version of the `ZipFile` object
+    to properly handle extraction of macOS apps so that permissions aren&#39;t
+    stripped.
+&#34;&#34;&#34;
+import os
+from zipfile import ZipFile, ZipInfo
+
+class MyZipFile(ZipFile):
+    def extract(self, member, path=None, pwd=None):
+        if not isinstance(member, ZipInfo):
+            member = self.getinfo(member)
+
+        if path is None:
+            path = os.getcwd()
+
+        ret_val = self._extract_member(member, path, pwd)
+        attr = member.external_attr &gt;&gt; 16
+        if attr != 0:
+            os.chmod(ret_val, attr)
+        return ret_val
+
+    def extractall(self, path=None, members=None, pwd=None):
+        if members is None:
+            members = self.namelist()
+
+        if path is None:
+            path = os.getcwd()
+        else:
+            path = os.fspath(path)
+
+        for zipinfo in members:
+            self.extract(zipinfo, path, pwd)</code></pre>
+</details>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-classes">Classes</h2>
+<dl>
+<dt id="renpy_distribute_tools.fixed_zipfile.MyZipFile"><code class="flex name class">
+<span>class <span class="ident">MyZipFile</span></span>
+<span>(</span><span>file, mode='r', compression=0, allowZip64=True, compresslevel=None)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Class with methods to open, read, write, close, list zip files.</p>
+<p>z = ZipFile(file, mode="r", compression=ZIP_STORED, allowZip64=True,
+compresslevel=None)</p>
+<p>file: Either the path to the file, or a file-like object.
+If it is a path, the file will be opened and closed by ZipFile.
+mode: The mode can be either read 'r', write 'w', exclusive create 'x',
+or append 'a'.
+compression: ZIP_STORED (no compression), ZIP_DEFLATED (requires zlib),
+ZIP_BZIP2 (requires bz2) or ZIP_LZMA (requires lzma).
+allowZip64: if True ZipFile will create files with ZIP64 extensions when
+needed, otherwise it will raise an exception when this would
+be necessary.
+compresslevel: None (default for the given compression type) or an integer
+specifying the level to pass to the compressor.
+When using ZIP_STORED or ZIP_LZMA this keyword has no effect.
+When using ZIP_DEFLATED integers 0 through 9 are accepted.
+When using ZIP_BZIP2 integers 1 through 9 are accepted.</p>
+<p>Open the ZIP file with mode read 'r', write 'w', exclusive create 'x',
+or append 'a'.</p></section>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">class MyZipFile(ZipFile):
+    def extract(self, member, path=None, pwd=None):
+        if not isinstance(member, ZipInfo):
+            member = self.getinfo(member)
+
+        if path is None:
+            path = os.getcwd()
+
+        ret_val = self._extract_member(member, path, pwd)
+        attr = member.external_attr &gt;&gt; 16
+        if attr != 0:
+            os.chmod(ret_val, attr)
+        return ret_val
+
+    def extractall(self, path=None, members=None, pwd=None):
+        if members is None:
+            members = self.namelist()
+
+        if path is None:
+            path = os.getcwd()
+        else:
+            path = os.fspath(path)
+
+        for zipinfo in members:
+            self.extract(zipinfo, path, pwd)</code></pre>
+</details>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li>zipfile.ZipFile</li>
+</ul>
+<h3>Methods</h3>
+<dl>
+<dt id="renpy_distribute_tools.fixed_zipfile.MyZipFile.extract"><code class="name flex">
+<span>def <span class="ident">extract</span></span>(<span>self, member, path=None, pwd=None)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Extract a member from the archive to the current working directory,
+using its full name. Its file information is extracted as accurately
+as possible. <code>member' may be a filename or a ZipInfo object. You can
+specify a different directory using</code>path'.</p></section>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def extract(self, member, path=None, pwd=None):
+    if not isinstance(member, ZipInfo):
+        member = self.getinfo(member)
+
+    if path is None:
+        path = os.getcwd()
+
+    ret_val = self._extract_member(member, path, pwd)
+    attr = member.external_attr &gt;&gt; 16
+    if attr != 0:
+        os.chmod(ret_val, attr)
+    return ret_val</code></pre>
+</details>
+</dd>
+<dt id="renpy_distribute_tools.fixed_zipfile.MyZipFile.extractall"><code class="name flex">
+<span>def <span class="ident">extractall</span></span>(<span>self, path=None, members=None, pwd=None)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Extract all members from the archive to the current working
+directory. <code>path' specifies a different directory to extract to.</code>members' is optional and must be a subset of the list returned
+by namelist().</p></section>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def extractall(self, path=None, members=None, pwd=None):
+    if members is None:
+        members = self.namelist()
+
+    if path is None:
+        path = os.getcwd()
+    else:
+        path = os.fspath(path)
+
+    for zipinfo in members:
+        self.extract(zipinfo, path, pwd)</code></pre>
+</details>
+</dd>
+</dl>
+</dd>
+</dl>
+</section>
+</article>
+<nav id="sidebar">
+<h1>Index</h1>
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="renpy_distribute_tools" href="index.html">renpy_distribute_tools</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-classes">Classes</a></h3>
+<ul>
+<li>
+<h4><code><a title="renpy_distribute_tools.fixed_zipfile.MyZipFile" href="#renpy_distribute_tools.fixed_zipfile.MyZipFile">MyZipFile</a></code></h4>
+<ul class="">
+<li><code><a title="renpy_distribute_tools.fixed_zipfile.MyZipFile.extract" href="#renpy_distribute_tools.fixed_zipfile.MyZipFile.extract">extract</a></code></li>
+<li><code><a title="renpy_distribute_tools.fixed_zipfile.MyZipFile.extractall" href="#renpy_distribute_tools.fixed_zipfile.MyZipFile.extractall">extractall</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.2</a>.</p>
+</footer>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
+<script>hljs.initHighlightingOnLoad()</script>
+</body>
+</html>