Skip to content

Commit 4d323a6

Browse files
pypidiffpypidiff
committed
changes: 202406012203
1 parent 83144fc commit 4d323a6

File tree

3 files changed

+326
-1
lines changed

3 files changed

+326
-1
lines changed

‎O/OpenTTDLab/0.0.8-0.0.9/README.md

+301
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,301 @@
1+
# Comparing `tmp/openttdlab-0.0.8.tar.gz` & `tmp/openttdlab-0.0.9.tar.gz`
2+
3+
## Comparing `openttdlab-0.0.8.tar` & `openttdlab-0.0.9.tar`
4+
5+
### file list
6+
7+
```diff
8+
@@ -1,6 +1,6 @@
9+
--rw-r--r-- 0 0 0 5927 2020-02-02 00:00:00.000000 openttdlab-0.0.8/openttdlab.py
10+
--rw-r--r-- 0 0 0 48 2020-02-02 00:00:00.000000 openttdlab-0.0.8/.gitignore
11+
--rw-r--r-- 0 0 0 18092 2020-02-02 00:00:00.000000 openttdlab-0.0.8/LICENSE
12+
--rw-r--r-- 0 0 0 3357 2020-02-02 00:00:00.000000 openttdlab-0.0.8/README.md
13+
--rw-r--r-- 0 0 0 1168 2020-02-02 00:00:00.000000 openttdlab-0.0.8/pyproject.toml
14+
--rw-r--r-- 0 0 0 4447 2020-02-02 00:00:00.000000 openttdlab-0.0.8/PKG-INFO
15+
+-rw-r--r-- 0 0 0 5927 2020-02-02 00:00:00.000000 openttdlab-0.0.9/openttdlab.py
16+
+-rw-r--r-- 0 0 0 48 2020-02-02 00:00:00.000000 openttdlab-0.0.9/.gitignore
17+
+-rw-r--r-- 0 0 0 18092 2020-02-02 00:00:00.000000 openttdlab-0.0.9/LICENSE
18+
+-rw-r--r-- 0 0 0 3450 2020-02-02 00:00:00.000000 openttdlab-0.0.9/README.md
19+
+-rw-r--r-- 0 0 0 1168 2020-02-02 00:00:00.000000 openttdlab-0.0.9/pyproject.toml
20+
+-rw-r--r-- 0 0 0 4540 2020-02-02 00:00:00.000000 openttdlab-0.0.9/PKG-INFO
21+
```
22+
23+
### Comparing `openttdlab-0.0.8/openttdlab.py` & `openttdlab-0.0.9/openttdlab.py`
24+
25+
* *Files identical despite different names*
26+
27+
### Comparing `openttdlab-0.0.8/LICENSE` & `openttdlab-0.0.9/LICENSE`
28+
29+
* *Files identical despite different names*
30+
31+
### Comparing `openttdlab-0.0.8/README.md` & `openttdlab-0.0.9/README.md`
32+
33+
* *Files 3% similar despite different names*
34+
35+
```diff
36+
@@ -1,22 +1,22 @@
37+
<p align="center">
38+
- <img alt="OpenTTDLab logo" width="256" height="254" src="./docs/assets/openttdlab-logo.svg">
39+
+ <img alt="OpenTTDLab logo" width="256" height="254" src="https://raw.githubusercontent.com/michalc/OpenTTDLab/main/docs/assets/openttdlab-logo.svg">
40+
</p>
41+
42+
-<p align="center"><strong>OpenTTDLab</strong> - <em>Run reproducible experiments on OpenTTD</em></p>
43+
+<p align="center"><strong>OpenTTDLab</strong> - <em>Run reproducible experiments using OpenTTD</em></p>
44+
45+
<p align="center">
46+
<a href="https://pypi.org/project/OpenTTDLab/"><img alt="PyPI package" src="https://img.shields.io/pypi/v/OpenTTDLab?label=PyPI%20package"></a>
47+
<a href="https://github.com/michalc/OpenTTDLab/actions/workflows/test.yml"><img alt="Test suite" src="https://img.shields.io/github/actions/workflow/status/michalc/OpenTTDLab/test.yml?label=Test%20suite"></a>
48+
<a href="https://app.codecov.io/gh/michalc/OpenTTDLab"><img alt="Code coverage" src="https://img.shields.io/codecov/c/github/michalc/OpenTTDLab?label=Code%20coverage"></a>
49+
</p>
50+
51+
---
52+
53+
-OpenTTD is a Python framework for running reproducible experiments using OpenTTD. An _experiment_ in OpenTTDLab terms is the combination of:
54+
+OpenTTD is a Python framework for running reproducible experiments using OpenTTD, and extracting results from them. An _experiment_ in OpenTTDLab terms is the combination of:
55+
56+
- Exact version of OpenTTD, any AIs used, and OpenTTDLab itself
57+
- Ranges of values for OpenTTD config settings, command line arguments and random seed
58+
- Granularity of output
59+
60+
This can be configured/extracted for each experiment in either machine or human readable forms, for use in code or publishing respectively.
61+
```
62+
63+
#### html2text {}
64+
65+
```diff
66+
@@ -1,37 +1,37 @@
67+
[OpenTTDLab logo]
68+
- OOppeennTTTTDDLLaabb - RRuunn rreepprroodduucciibbllee eexxppeerriimmeennttss oonn OOppeennTTTTDD
69+
+ OOppeennTTTTDDLLaabb - RRuunn rreepprroodduucciibbllee eexxppeerriimmeennttss uussiinngg OOppeennTTTTDD
70+
_[_P_y_P_I_ _p_a_c_k_a_g_e_]_[_T_e_s_t_ _s_u_i_t_e_]_[_C_o_d_e_ _c_o_v_e_r_a_g_e_]
71+
--- OpenTTD is a Python framework for running reproducible experiments using
72+
-OpenTTD. An _experiment_ in OpenTTDLab terms is the combination of: - Exact
73+
-version of OpenTTD, any AIs used, and OpenTTDLab itself - Ranges of values for
74+
-OpenTTD config settings, command line arguments and random seed - Granularity
75+
-of output This can be configured/extracted for each experiment in either
76+
-machine or human readable forms, for use in code or publishing respectively.
77+
-OpenTTDLab is based on [TrueBrain's OpenTTD Savegame Reader](https://
78+
-github.com/TrueBrain/OpenTTD-savegame-reader), but it is not affiliated with
79+
-OpenTTD. > [!NOTE] > Work in progress. This README serves as a rough design
80+
-spec. ## Installation ```shell python -m pip install OpenTTDLab ``` On macOS,
81+
-OpenTTDLab requires [7-zip](https://www.7-zip.org/), but this is not installed
82+
-automatically. To install 7-zip on macOS, first install [Homebrew](https://
83+
-brew.sh/), and then use Homebrew to install the p7zip package that contains 7-
84+
-zip. ```shell brew install p7zip ``` ## Running an experiment The core function
85+
-of OpenTTD is the `setup_experiment` function. ```python from openttdlab import
86+
-setup_experiment, save_config # If necessary, this will download the latest
87+
-OpenTTD run_experiment, get_config = setup_experiment() # Run the experiment
88+
-and get results. This may take time results = run_experiment() print(results) #
89+
-The information needed to reproduce the experiment config = get_config() print
90+
-(config) # Which can be saved to a file and then shared save_config('my-
91+
-config.yml', config) ``` ## Reproducing an experiment If you have the config
92+
-from a previous experiment, you can pass it into `setup_experiment` to exactly
93+
-reproduce ```python from openttdlab import setup_experiment, load_config # Load
94+
-the config from file config = load_config('my-config.yml') #
95+
-allow_platform_difference=True will allow experiments from a platform other
96+
-than the one # the original experiments were performed on. Otherwise,
97+
-setup_experiment may error because # the exact same OpenTTD will not be able to
98+
-be run on this platform run_experiment, get_config = setup_experiment
99+
-(config=config, allow_platform_difference=True) # Run the experiment and get
100+
-results results = run_experiment() print(results) ``` ## API design
101+
-considerations - Mutability is avoided - Impure functions are avoided - In
102+
-terms of the user-facing API, keeping it mostly OOP-free, and deliberately
103+
+OpenTTD, and extracting results from them. An _experiment_ in OpenTTDLab terms
104+
+is the combination of: - Exact version of OpenTTD, any AIs used, and OpenTTDLab
105+
+itself - Ranges of values for OpenTTD config settings, command line arguments
106+
+and random seed - Granularity of output This can be configured/extracted for
107+
+each experiment in either machine or human readable forms, for use in code or
108+
+publishing respectively. OpenTTDLab is based on [TrueBrain's OpenTTD Savegame
109+
+Reader](https://github.com/TrueBrain/OpenTTD-savegame-reader), but it is not
110+
+affiliated with OpenTTD. > [!NOTE] > Work in progress. This README serves as a
111+
+rough design spec. ## Installation ```shell python -m pip install OpenTTDLab
112+
+``` On macOS, OpenTTDLab requires [7-zip](https://www.7-zip.org/), but this is
113+
+not installed automatically. To install 7-zip on macOS, first install
114+
+[Homebrew](https://brew.sh/), and then use Homebrew to install the p7zip
115+
+package that contains 7-zip. ```shell brew install p7zip ``` ## Running an
116+
+experiment The core function of OpenTTD is the `setup_experiment` function.
117+
+```python from openttdlab import setup_experiment, save_config # If necessary,
118+
+this will download the latest OpenTTD run_experiment, get_config =
119+
+setup_experiment() # Run the experiment and get results. This may take time
120+
+results = run_experiment() print(results) # The information needed to reproduce
121+
+the experiment config = get_config() print(config) # Which can be saved to a
122+
+file and then shared save_config('my-config.yml', config) ``` ## Reproducing an
123+
+experiment If you have the config from a previous experiment, you can pass it
124+
+into `setup_experiment` to exactly reproduce ```python from openttdlab import
125+
+setup_experiment, load_config # Load the config from file config = load_config
126+
+('my-config.yml') # allow_platform_difference=True will allow experiments from
127+
+a platform other than the one # the original experiments were performed on.
128+
+Otherwise, setup_experiment may error because # the exact same OpenTTD will not
129+
+be able to be run on this platform run_experiment, get_config =
130+
+setup_experiment(config=config, allow_platform_difference=True) # Run the
131+
+experiment and get results results = run_experiment() print(results) ``` ## API
132+
+design considerations - Mutability is avoided - Impure functions are avoided -
133+
+In terms of the user-facing API, keeping it mostly OOP-free, and deliberately
134+
focused on key behaviour - Designed so if type checking were in place and
135+
passes, API misuse should be close to impossible
136+
```
137+
138+
### Comparing `openttdlab-0.0.8/pyproject.toml` & `openttdlab-0.0.9/pyproject.toml`
139+
140+
* *Files 0% similar despite different names*
141+
142+
```diff
143+
@@ -1,14 +1,14 @@
144+
[build-system]
145+
requires = ["hatchling"]
146+
build-backend = "hatchling.build"
147+
148+
[project]
149+
name = "OpenTTDLab"
150+
-version = "0.0.8"
151+
+version = "0.0.9"
152+
authors = [
153+
{ name="Michal Charemza", email="[email protected]" },
154+
# Author of https://github.com/TrueBrain/OpenTTD-savegame-reader, which OpenTTDLab is a fork of
155+
{ name="Patric Stout", email="[email protected]" },
156+
]
157+
description = "Python framework for running reproducible experiments using OpenTTD"
158+
readme = "README.md"
159+
```
160+
161+
### Comparing `openttdlab-0.0.8/PKG-INFO` & `openttdlab-0.0.9/PKG-INFO`
162+
163+
* *Files 2% similar despite different names*
164+
165+
```diff
166+
@@ -1,10 +1,10 @@
167+
Metadata-Version: 2.1
168+
Name: OpenTTDLab
169+
-Version: 0.0.8
170+
+Version: 0.0.9
171+
Summary: Python framework for running reproducible experiments using OpenTTD
172+
Project-URL: Source, https://github.com/michalc/OpenTTDLab
173+
Author-email: Michal Charemza <[email protected]>, Patric Stout <[email protected]>
174+
License-File: LICENSE
175+
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
176+
Classifier: Operating System :: OS Independent
177+
Classifier: Programming Language :: Python :: 3
178+
@@ -22,28 +22,28 @@
179+
Provides-Extra: dev
180+
Requires-Dist: coverage>=7.4.0; extra == 'dev'
181+
Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
182+
Requires-Dist: pytest>=7.4.4; extra == 'dev'
183+
Description-Content-Type: text/markdown
184+
185+
<p align="center">
186+
- <img alt="OpenTTDLab logo" width="256" height="254" src="./docs/assets/openttdlab-logo.svg">
187+
+ <img alt="OpenTTDLab logo" width="256" height="254" src="https://raw.githubusercontent.com/michalc/OpenTTDLab/main/docs/assets/openttdlab-logo.svg">
188+
</p>
189+
190+
-<p align="center"><strong>OpenTTDLab</strong> - <em>Run reproducible experiments on OpenTTD</em></p>
191+
+<p align="center"><strong>OpenTTDLab</strong> - <em>Run reproducible experiments using OpenTTD</em></p>
192+
193+
<p align="center">
194+
<a href="https://pypi.org/project/OpenTTDLab/"><img alt="PyPI package" src="https://img.shields.io/pypi/v/OpenTTDLab?label=PyPI%20package"></a>
195+
<a href="https://github.com/michalc/OpenTTDLab/actions/workflows/test.yml"><img alt="Test suite" src="https://img.shields.io/github/actions/workflow/status/michalc/OpenTTDLab/test.yml?label=Test%20suite"></a>
196+
<a href="https://app.codecov.io/gh/michalc/OpenTTDLab"><img alt="Code coverage" src="https://img.shields.io/codecov/c/github/michalc/OpenTTDLab?label=Code%20coverage"></a>
197+
</p>
198+
199+
---
200+
201+
-OpenTTD is a Python framework for running reproducible experiments using OpenTTD. An _experiment_ in OpenTTDLab terms is the combination of:
202+
+OpenTTD is a Python framework for running reproducible experiments using OpenTTD, and extracting results from them. An _experiment_ in OpenTTDLab terms is the combination of:
203+
204+
- Exact version of OpenTTD, any AIs used, and OpenTTDLab itself
205+
- Ranges of values for OpenTTD config settings, command line arguments and random seed
206+
- Granularity of output
207+
208+
This can be configured/extracted for each experiment in either machine or human readable forms, for use in code or publishing respectively.
209+
```
210+
211+
#### html2text {}
212+
213+
```diff
214+
@@ -1,8 +1,8 @@
215+
-Metadata-Version: 2.1 Name: OpenTTDLab Version: 0.0.8 Summary: Python framework
216+
+Metadata-Version: 2.1 Name: OpenTTDLab Version: 0.0.9 Summary: Python framework
217+
for running reproducible experiments using OpenTTD Project-URL: Source, https:/
218+
/github.com/michalc/OpenTTDLab Author-email: Michal Charemza
219+
charemza.name>, Patric Stout
220+
openttd.org> License-File: LICENSE Classifier: License :: OSI Approved :: GNU
221+
General Public License v2 (GPLv2) Classifier: Operating System :: OS
222+
Independent Classifier: Programming Language :: Python :: 3 Requires-Python:
223+
>=3.8.0 Requires-Dist: httpx>=0.26.0 Requires-Dist: platformdirs>=4.1.0
224+
@@ -10,43 +10,43 @@
225+
extra == 'ci' Requires-Dist: httpx==0.26.0; extra == 'ci' Requires-Dist:
226+
platformdirs==4.1.0; extra == 'ci' Requires-Dist: pytest-cov==4.1.0; extra ==
227+
'ci' Requires-Dist: pytest==7.4.4; extra == 'ci' Requires-Dist: pyyaml==6.0.1;
228+
extra == 'ci' Provides-Extra: dev Requires-Dist: coverage>=7.4.0; extra ==
229+
'dev' Requires-Dist: pytest-cov>=4.1.0; extra == 'dev' Requires-Dist:
230+
pytest>=7.4.4; extra == 'dev' Description-Content-Type: text/markdown
231+
[OpenTTDLab logo]
232+
- OOppeennTTTTDDLLaabb - RRuunn rreepprroodduucciibbllee eexxppeerriimmeennttss oonn OOppeennTTTTDD
233+
+ OOppeennTTTTDDLLaabb - RRuunn rreepprroodduucciibbllee eexxppeerriimmeennttss uussiinngg OOppeennTTTTDD
234+
_[_P_y_P_I_ _p_a_c_k_a_g_e_]_[_T_e_s_t_ _s_u_i_t_e_]_[_C_o_d_e_ _c_o_v_e_r_a_g_e_]
235+
--- OpenTTD is a Python framework for running reproducible experiments using
236+
-OpenTTD. An _experiment_ in OpenTTDLab terms is the combination of: - Exact
237+
-version of OpenTTD, any AIs used, and OpenTTDLab itself - Ranges of values for
238+
-OpenTTD config settings, command line arguments and random seed - Granularity
239+
-of output This can be configured/extracted for each experiment in either
240+
-machine or human readable forms, for use in code or publishing respectively.
241+
-OpenTTDLab is based on [TrueBrain's OpenTTD Savegame Reader](https://
242+
-github.com/TrueBrain/OpenTTD-savegame-reader), but it is not affiliated with
243+
-OpenTTD. > [!NOTE] > Work in progress. This README serves as a rough design
244+
-spec. ## Installation ```shell python -m pip install OpenTTDLab ``` On macOS,
245+
-OpenTTDLab requires [7-zip](https://www.7-zip.org/), but this is not installed
246+
-automatically. To install 7-zip on macOS, first install [Homebrew](https://
247+
-brew.sh/), and then use Homebrew to install the p7zip package that contains 7-
248+
-zip. ```shell brew install p7zip ``` ## Running an experiment The core function
249+
-of OpenTTD is the `setup_experiment` function. ```python from openttdlab import
250+
-setup_experiment, save_config # If necessary, this will download the latest
251+
-OpenTTD run_experiment, get_config = setup_experiment() # Run the experiment
252+
-and get results. This may take time results = run_experiment() print(results) #
253+
-The information needed to reproduce the experiment config = get_config() print
254+
-(config) # Which can be saved to a file and then shared save_config('my-
255+
-config.yml', config) ``` ## Reproducing an experiment If you have the config
256+
-from a previous experiment, you can pass it into `setup_experiment` to exactly
257+
-reproduce ```python from openttdlab import setup_experiment, load_config # Load
258+
-the config from file config = load_config('my-config.yml') #
259+
-allow_platform_difference=True will allow experiments from a platform other
260+
-than the one # the original experiments were performed on. Otherwise,
261+
-setup_experiment may error because # the exact same OpenTTD will not be able to
262+
-be run on this platform run_experiment, get_config = setup_experiment
263+
-(config=config, allow_platform_difference=True) # Run the experiment and get
264+
-results results = run_experiment() print(results) ``` ## API design
265+
-considerations - Mutability is avoided - Impure functions are avoided - In
266+
-terms of the user-facing API, keeping it mostly OOP-free, and deliberately
267+
+OpenTTD, and extracting results from them. An _experiment_ in OpenTTDLab terms
268+
+is the combination of: - Exact version of OpenTTD, any AIs used, and OpenTTDLab
269+
+itself - Ranges of values for OpenTTD config settings, command line arguments
270+
+and random seed - Granularity of output This can be configured/extracted for
271+
+each experiment in either machine or human readable forms, for use in code or
272+
+publishing respectively. OpenTTDLab is based on [TrueBrain's OpenTTD Savegame
273+
+Reader](https://github.com/TrueBrain/OpenTTD-savegame-reader), but it is not
274+
+affiliated with OpenTTD. > [!NOTE] > Work in progress. This README serves as a
275+
+rough design spec. ## Installation ```shell python -m pip install OpenTTDLab
276+
+``` On macOS, OpenTTDLab requires [7-zip](https://www.7-zip.org/), but this is
277+
+not installed automatically. To install 7-zip on macOS, first install
278+
+[Homebrew](https://brew.sh/), and then use Homebrew to install the p7zip
279+
+package that contains 7-zip. ```shell brew install p7zip ``` ## Running an
280+
+experiment The core function of OpenTTD is the `setup_experiment` function.
281+
+```python from openttdlab import setup_experiment, save_config # If necessary,
282+
+this will download the latest OpenTTD run_experiment, get_config =
283+
+setup_experiment() # Run the experiment and get results. This may take time
284+
+results = run_experiment() print(results) # The information needed to reproduce
285+
+the experiment config = get_config() print(config) # Which can be saved to a
286+
+file and then shared save_config('my-config.yml', config) ``` ## Reproducing an
287+
+experiment If you have the config from a previous experiment, you can pass it
288+
+into `setup_experiment` to exactly reproduce ```python from openttdlab import
289+
+setup_experiment, load_config # Load the config from file config = load_config
290+
+('my-config.yml') # allow_platform_difference=True will allow experiments from
291+
+a platform other than the one # the original experiments were performed on.
292+
+Otherwise, setup_experiment may error because # the exact same OpenTTD will not
293+
+be able to be run on this platform run_experiment, get_config =
294+
+setup_experiment(config=config, allow_platform_difference=True) # Run the
295+
+experiment and get results results = run_experiment() print(results) ``` ## API
296+
+design considerations - Mutability is avoided - Impure functions are avoided -
297+
+In terms of the user-facing API, keeping it mostly OOP-free, and deliberately
298+
focused on key behaviour - Designed so if type checking were in place and
299+
passes, API misuse should be close to impossible
300+
```
301+

0 commit comments

Comments
 (0)