1
0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-19 10:27:38 +03:00

119 Commits

Author SHA1 Message Date
Athanasius
bd1b86d3a3 Suits/Loadouts: Always convert to dict form for simpler downstream code. 2021-04-29 11:30:55 +01:00
Athanasius
eb04673751 PLUGINS.md: Document dual-type of Suits, and helper functions. 2021-04-19 12:30:24 +01:00
Athanasius
29473de031 PLUGINS.md: Update for all added Odyssey monitor.state fields 2021-04-13 12:26:33 +01:00
Athanasius
9a6b59fbd3 monitor.py: Initialise EDLogs self.systempopulation
This is the *one* field that wasn't always initialised.
2021-04-12 09:10:25 +01:00
Athanasius
33f0064dab Document edmc_data.py
* PLUGINS.md - now we only need mention this for such data.
* ChangeLog.md - pre-emptive section.
2021-04-12 08:31:47 +01:00
Athanasius
74a2b70a19 PLUGINS.md: Add ship_utils.ship_map to allowed imports 2021-04-12 08:30:51 +01:00
Athanasius
8f2802fbcf monitor.py: Add support for Odyssey 'Component' materials. 2021-04-12 08:30:51 +01:00
Athanasius
5edf8d5b59 Change monitor.state['on_foot'] to 'OnFoot' for consistency 2021-04-12 08:30:51 +01:00
Athanasius
f40f6464b6 PLUGINS.md: Document state['on_foot']
* Also restore 'New in' bits to just below the table.
2021-04-12 08:30:51 +01:00
Athanasius
7ae40591ad PLUGINS.md: Big cleanup
* New 'Avoiding potential pitfalls' section to be sure we list them all.
* All plain text now wrapped at 80 columns.
* Re-did all the section headings for consistency, and added many `---`
  between sections.
* Headers added within the 'Plugin-specific events' section.
2021-04-01 14:46:43 +01:00
Athanasius
5de4950fba Change config.appversion() to return semantic_version.Version
As we're changing it to a function at this stage anyway, it might as
well return this type, not a str.
2021-04-01 14:46:43 +01:00
Athanasius
b841d434e5 plugintest: Document core version code & add to PLUGINS.md
* New PLUGINS.md section 'Checking core EDMC version'.
* And the same comments might as well be in the plugintest/load.py.
2021-04-01 14:46:43 +01:00
Athanasius
5a38537294 docs: General update for main now using Python 3.9 & misc
* Extend EDCD copyright into 2021 here as well.
* Recommend *against* any attempt at making plugins also work with
  Python 2.7.
* setup.py no longer writes appcast files.  Mention
  edmarketconnector.xml enclosure instead for the url= bit.
* DRY about location of log files, just point to appropriate wiki link.
2021-04-01 14:45:51 +01:00
Athanasius
3fddd2bdf9 try/except ModulesInfo.json load & fully document 2021-04-01 14:45:50 +01:00
Athanasius
1ee2be8fc8 Call out discrepancies between Journal doc v28 and reality in 3.7.x 2021-04-01 14:45:50 +01:00
Athanasius
b3a1b0492e Correct event and file name to NavRoute(.json) & expand docs
* Despite what section 4.18 of v28 Journal docs say, the event is
  `NavRoute`, not `Route`, and the file is `NavRoute.json`.  The array
  of hops is still keyed as `Route` though.

* Calls out that both `NavRoute` and `Cargo` events, as passed to
  plugins, are augmented with the data from their respective files, and
  are not simply the 'bare' event as seen in the Journal.
2021-04-01 14:45:50 +01:00
Athanasius
ef891fa8bd Initial support for Route.json file 2021-04-01 14:45:50 +01:00
Athanasius
b3b72a05a8 PLUGINS.md: Be explicit about why plugin_prefs(...) -> Optional[tk.Frame] 2021-04-01 14:45:47 +01:00
Athanasius
903ec3d558 Added mention of deprecated methods
# Conflicts:
#	PLUGINS.md
2021-04-01 14:45:47 +01:00
A_D
b5282fc8ea Deprecated camelCase methods
Python prefers snake_case methods and camelCase classes. This replaces
some camelCase methods with snake_case variants, and has the original
names raise a DeprecationWarning before calling the snake_case versions
2021-04-01 14:45:47 +01:00
A_D
a68468d7ce Updated wording in plugins docs 2021-04-01 14:45:46 +01:00
A_D
dc793e62c4 Updated plugin docs with new config info 2021-04-01 14:45:46 +01:00
Athanasius
1563e50733 PLUGINS.md: Reference Releasing.md for currently supported Python version 2021-04-01 14:45:43 +01:00
Athanasius
1b4ee4f3dd PLUGINS.md: Update to mention using Python 3.8 post-4.1.x
* Also adjusted links to information/examples to not be the bad 'here'
  form.
2021-04-01 14:45:43 +01:00
Athanasius
8ceca8912e PLUGINS.md: Reference Releasing.md for currently supported Python version 2021-04-01 14:45:12 +01:00
Athanasius
8f721cf06e PLUGINS.md: Update to mention using Python 3.8 post-4.1.x
* Also adjusted links to information/examples to not be the bad 'here'
  form.
2021-04-01 14:45:12 +01:00
Athanasius
a13946efd9 PLUGINS.md: Update old master branch link to main
Closes #924
2021-03-21 11:02:33 +00:00
Athanasius
4658b267fb PLUGINS: Document that CargoJSON isn't initially populated.
Blame Frontier for deciding to put this in-Journal on the first event at
login, but in the separate file after that.
2021-03-09 12:27:00 +00:00
Athanasius
872f380831 PLUGINS.md: Correct and expand on monitor.game_running() documentation 2021-02-18 09:29:52 +00:00
alterNERDtive
589f0cf454
PLUGINS.md: fix typo & example for journal_entry 2021-01-13 14:06:27 +01:00
A_D
416b73bc3b Modified location of state updates 2021-01-05 14:34:52 +00:00
A_D
13f7b62fe8 Added cargoJSON to state docs 2021-01-05 14:34:52 +00:00
A_D
1be723e249 Added additional doccumentation 2021-01-05 14:34:51 +00:00
Athanasius
c1dcd30280 PLUGINS.md: Be explicit about why plugin_prefs(...) -> Optional[tk.Frame] 2020-12-21 14:44:39 +00:00
Athanasius
a65d77a67e PLUGINS.md: Make the disctinction between "ShutDown" and "Shutdown" clear 2020-12-18 12:32:45 +00:00
Athanasius
a181379669 PLUGINS.md: Point to current Python version information in Releasing.md 2020-12-12 14:02:11 +00:00
Joshua Tyler-Jones
1c16b5fae6
Fix dead link in PLUGINS.md 2020-12-08 15:08:27 +00:00
A_D
97d8631e11
Removed todo 2020-09-22 15:22:27 +02:00
A_D
9c3f273027
Added type hints and param descriptions 2020-09-22 15:20:46 +02:00
A_D
5ae269d7f6
Added type annotations to examples 2020-09-22 15:20:46 +02:00
A_D
161ca24bb6
updated plugin docs 2020-09-22 15:20:45 +02:00
A_D
4ecb378b83
cleaned up plugins.md 2020-09-22 15:20:44 +02:00
Athanasius
a19fd3cbf6 PLUGINS.md: Emphasise the correct way to get a logger.
A_D had accidentally used 'ClickCounter' for this when their folder name
was 'click_counter'.  This lead to using a very bare `logger` which
still used our defined format leading to things blowing up when there
was no adapter to handle `qualname` format string.
2020-09-18 13:07:44 +01:00
Athanasius
4d3f9264f2 PLUGINS.md: Correct example to 'tkinter' not 'Tkinter'. 2020-09-10 18:31:09 +01:00
Athanasius
cd0d0f9e08 PLUGINS.md: Update for logging now being available 2020-09-07 17:38:15 +01:00
A_D
81dfbdfb8e
Added timeout_session, made inara use it
timeout_session provides two things, TimeoutAdapter, a HTTP adapter
subclass that automatically adds timeouts to all requests, and
new_session, which automatically creates a request.Session with the
adapter in the correct place.
2020-07-31 15:53:20 +02:00
Athanasius
0115e5c6ba PLUGINS.md: except not catch 2020-07-30 14:33:00 +01:00
Athanasius
0e6d4468da PLUGINS.md: Fix typo ' -> ` 2020-07-30 14:17:14 +01:00
Athanasius
974872fe9e PLUGINS.md: Logging is being added, how to prepare
* Currently you use `print(...)`
* `logging` support is coming, here's how to prepare.
2020-07-30 14:05:09 +01:00
Athanasius
ddadaf36f2 Update PLUGINS.md
Adds missing blank line that caused acciental underline/heading
2020-07-24 13:45:17 +01:00