TweetyPy

Check-in [b95740c293]

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Typos & grammar fixes in info.html; allow WM to chose size in mainwin.py
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: b95740c2930106cc6e3302a043af0e1d4b896ef42e9e4f1b06caef388dc0354c
User & Date: jmcclure 2017-09-28 12:45:46
Context
2017-09-28
12:48
Updated fex paper link to DOI check-in: d5d399a28b user: jmcclure tags: trunk
12:45
Typos & grammar fixes in info.html; allow WM to chose size in mainwin.py check-in: b95740c293 user: jmcclure tags: trunk
2017-09-13
00:51
Usage documentation check-in: 23934f44e6 user: jmcclure tags: trunk
Changes

Changes to info.html.

77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
...
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
...
169
170
171
172
173
174
175
176
177
178

179
180
181
182
183
184
185
<a href="#install">Next</a>
</div>
-->
</section>

<section id="install">
<h2>Installation</h2>
<p>TweetyPy will run on any system capable of running Python 3.6<a class="note-link"
href="#install-note-1">1</a> and Qt5<a class="note-link"
href="#install-note-2">2</a>.  TweetyPy is available from the PyPi &ldquo;Cheese
Shop&rdquo;<a class="note-link" href="#install-note=3">3</a> which will be
updated with each minor-version release.  These releases &mdash; as well as the most
recent development code &mdash; can also be obtained directly from the
Fossil VCS source<a class="note-link" href="#install-note=4">4</a>.  Once Python
3.6 is installed on your system, TweetyPy can be installed directly
from PyPi via pip:</p>
<pre><code>pip install tweetypy</code></pre>
<p>Alternatively, TweetyPy can be installed from sources retrieved from PyPi or
Fossil with the following command from within the top-level directory of the
source files:</p>
<pre><code>python setup.py install</code></pre>
<p>In either case <code>setuptools</code> should install the remaining
depdendencies numpy<a class="note-link" href="#install-note-5">5</a>,
scipy<a class="note-link" href="#install-note-6">6</a>, and
PyYAML<a class="note-link" href="#install-note-7">7</a>.  If not, these may need
to be installed separately.</p>
<h3 id="install-mac">Mac OSX</h3>
<p>Mac OSX typically comes with python preinstalled, however it is an older
version of python.  You will need to install python 3.6 or later<a
class="note-link" href="#install-note-1">1</a>.  The installer will install
python3 along-side any existing python2 installation, however the default python
and pip commands will still use the python2 versions so you will need to use the
-3 suffix for pip.  Once python 3.6 is installed, the following command in a
terminal should suffice to complete the installation of tweetypy:</p>
<pre><code>pip3 install tweetypy</code></pre>
<p>This should install all the dependencies followed by tweetypy itself.
Preliminary testing on a mac resulted in a successful installation and minimal
test of a working tweetypy install.</p>
................................................................................
available.</p>
<ol>
<li>Install python 3.6 or newer from the python website.
<li>Download a suitable version of NumPy and SciPy from Christoph Gohlke's page
at the University of California<a class="note-link"
href="#install-note-10">10</a>.  I used the cp36-cp36m-win32 builds for my test
on Windows 10.</li>
<li>Install each of the downloaded wheel files NumPy first, then SciPy.  From a
console / dos prompt:
<pre><code>cd \path\to\Downloads
pip install numpy-1.13.1+mkl-cp36-cp36m-win32.whl
pip install scipy-0.19.1-cp36-cp36m-win32.whl</code></pre></li>
<li>If the above dependencies installed successfully you should not be able to
install tweetypy from PyPi:
<pre><code>pip install tweetypy</code></pre>
This should find the existing installation of NumPy and SciPy and only install
the remaining needed dependencies followed by tweetypy.</li>
</ol>
<p>Preliminary testing on Windows 10 resulted in a successful installation and
minimal test of a working tweetypy install.</p>
................................................................................
which for general use can be viewed as simple key-value pairs.  To customize
your configuration, copy config.yaml from the python site-packages directory
where it was installed to your user's configuration directory.</p>
<p>TweetyPy reads configuration from any <code>config.yaml</code> files in
order from the site-packages directory, platform-specific configuration
directories, and the present working directory with settings in each file
taking precedence over previous settings.  On Mac-OSX and Linux, the
configuration directories are <code>$XDG_CONFIG_HOME/tweetypy/</code> and
<code>$HOME/.config/tweetypy/</code> and on Windows
<code>%APPDATA%\tweetypy\</code>.</p>

<p>Details of the configurable settings will be coming soon.  For now, feel free
to review the configuration files as many settings may be self-explanatory.</p>
<ol class="notes">
<li id="config1-note-1"><a
href="https://en.wikipedia.org/wiki/YAML">Wikipedia</a> has a good introduction
to YAML.</li>
</ol>







|






|
<












|
|
|







 







|
|



|







 







|
|
|
>







77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
...
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
...
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
<a href="#install">Next</a>
</div>
-->
</section>

<section id="install">
<h2>Installation</h2>
<p>TweetyPy will run on any system with Python 3.6<a class="note-link"
href="#install-note-1">1</a> and Qt5<a class="note-link"
href="#install-note-2">2</a>.  TweetyPy is available from the PyPi &ldquo;Cheese
Shop&rdquo;<a class="note-link" href="#install-note=3">3</a> which will be
updated with each minor-version release.  These releases &mdash; as well as the most
recent development code &mdash; can also be obtained directly from the
Fossil VCS source<a class="note-link" href="#install-note=4">4</a>.  Once Python
3.6 is on your system, TweetyPy can be installed directly from PyPi via pip:</p>

<pre><code>pip install tweetypy</code></pre>
<p>Alternatively, TweetyPy can be installed from sources retrieved from PyPi or
Fossil with the following command from within the top-level directory of the
source files:</p>
<pre><code>python setup.py install</code></pre>
<p>In either case <code>setuptools</code> should install the remaining
depdendencies numpy<a class="note-link" href="#install-note-5">5</a>,
scipy<a class="note-link" href="#install-note-6">6</a>, and
PyYAML<a class="note-link" href="#install-note-7">7</a>.  If not, these may need
to be installed separately.</p>
<h3 id="install-mac">Mac OSX</h3>
<p>Mac OSX typically comes with python preinstalled, however it is an older
version of python.  You will need python 3.6 or later<a
class="note-link" href="#install-note-1">1</a>.  Python 3.6 will be installed
along-side the existing python2 installation, however the default python
and pip commands will still use the python2 versions so you will need to use the
-3 suffix for pip.  Once python 3.6 is installed, the following command in a
terminal should suffice to complete the installation of tweetypy:</p>
<pre><code>pip3 install tweetypy</code></pre>
<p>This should install all the dependencies followed by tweetypy itself.
Preliminary testing on a mac resulted in a successful installation and minimal
test of a working tweetypy install.</p>
................................................................................
available.</p>
<ol>
<li>Install python 3.6 or newer from the python website.
<li>Download a suitable version of NumPy and SciPy from Christoph Gohlke's page
at the University of California<a class="note-link"
href="#install-note-10">10</a>.  I used the cp36-cp36m-win32 builds for my test
on Windows 10.</li>
<li>Install each of the wheels, NumPy first, then SciPy.  From a console / dos
prompt:
<pre><code>cd \path\to\Downloads
pip install numpy-1.13.1+mkl-cp36-cp36m-win32.whl
pip install scipy-0.19.1-cp36-cp36m-win32.whl</code></pre></li>
<li>If the above dependencies installed successfully you should now be able to
install tweetypy from PyPi:
<pre><code>pip install tweetypy</code></pre>
This should find the existing installation of NumPy and SciPy and only install
the remaining needed dependencies followed by tweetypy.</li>
</ol>
<p>Preliminary testing on Windows 10 resulted in a successful installation and
minimal test of a working tweetypy install.</p>
................................................................................
which for general use can be viewed as simple key-value pairs.  To customize
your configuration, copy config.yaml from the python site-packages directory
where it was installed to your user's configuration directory.</p>
<p>TweetyPy reads configuration from any <code>config.yaml</code> files in
order from the site-packages directory, platform-specific configuration
directories, and the present working directory with settings in each file
taking precedence over previous settings.  On Mac-OSX and Linux, the
configuration directories are <code>$XDG_CONFIG_HOME/tweetypy/</code> or
<code>$HOME/.config/tweetypy/</code> if XDG_CONFIG_HOME is not set and on Windows
<code>%APPDATA%\tweetypy\</code> or <code>%USERPROFILE%\AppData\tweetypy\</code>
if APPDATA is not set.</p>
<p>Details of the configurable settings will be coming soon.  For now, feel free
to review the configuration files as many settings may be self-explanatory.</p>
<ol class="notes">
<li id="config1-note-1"><a
href="https://en.wikipedia.org/wiki/YAML">Wikipedia</a> has a good introduction
to YAML.</li>
</ol>

Changes to tweetypy/mainwin.py.

8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
class MainWin(QMainWindow):
	def __init__(self, files, config):
		super().__init__()
		self.files = files
		self.data = []
		self.saved = True
		self.config = config
		self.setGeometry(0, 0, 800, 600)
		self.setWindowTitle("TweetyPy")
		self.setWindowIcon(QIcon('web.png'))	# TODO FIXME
		if self.config['main-window']['maximized']:
			self.setWindowState(Qt.WindowMaximized)
		self.init_calls()
		self.init_actions()
		self.init_menubar()







|







8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
class MainWin(QMainWindow):
	def __init__(self, files, config):
		super().__init__()
		self.files = files
		self.data = []
		self.saved = True
		self.config = config
		#self.setGeometry(0, 0, 800, 600)
		self.setWindowTitle("TweetyPy")
		self.setWindowIcon(QIcon('web.png'))	# TODO FIXME
		if self.config['main-window']['maximized']:
			self.setWindowState(Qt.WindowMaximized)
		self.init_calls()
		self.init_actions()
		self.init_menubar()