ortler 0.2.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
ortler-0.2.4/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
ortler-0.2.4/PKG-INFO ADDED
@@ -0,0 +1,180 @@
1
+ Metadata-Version: 2.4
2
+ Name: ortler
3
+ Version: 0.2.4
4
+ Project-URL: Homepage, https://github.com/ad-freiburg/ortler
5
+ Project-URL: Repository, https://github.com/ad-freiburg/ortler
6
+ Requires-Python: >=3.10
7
+ Description-Content-Type: text/markdown
8
+ License-File: LICENSE
9
+ Requires-Dist: openreview-py
10
+ Requires-Dist: argcomplete
11
+ Requires-Dist: numpy
12
+ Requires-Dist: openai
13
+ Requires-Dist: pdf2image
14
+ Requires-Dist: reportlab
15
+ Requires-Dist: python-dotenv
16
+ Requires-Dist: termcolor
17
+ Dynamic: license-file
18
+
19
+ # ortler
20
+
21
+ Ortler is a powerful and versatile command-line tool for managing OpenReview venues.
22
+ It provides commands for syncing venue data to a local cache, managing committee recruitment,
23
+ tracking submissions, and sending emails via the OpenReview API. It is named after OpenReview
24
+ and a beautiful mountain in the Alps.
25
+
26
+ <img width="1476" height="431" alt="image" src="https://github.com/user-attachments/assets/4298fc2f-16c4-489a-9a70-858fc03b65b3" />
27
+
28
+ ## Quickstart
29
+
30
+ ### Installation
31
+
32
+ ```bash
33
+ # Install with pipx (recommended)
34
+ pipx install git+https://github.com/ad-freiburg/ortler.git
35
+
36
+ # Or with pip in a virtual environment
37
+ python3 -m venv venv && source venv/bin/activate
38
+ pip install git+https://github.com/ad-freiburg/ortler.git
39
+
40
+ # Or install in editable mode for development
41
+ git clone git@github.com:ad-freiburg/ortler.git
42
+ cd ortler
43
+ pipx install -e .
44
+ ```
45
+
46
+ ### Configuration
47
+
48
+ Create a `.env` file with your OpenReview credentials (see `.env.example`):
49
+
50
+ ```bash
51
+ OPENREVIEW_API_URL=https://api2.openreview.net
52
+ OPENREVIEW_USERNAME=your.email@example.com
53
+ OPENREVIEW_PASSWORD=your-password
54
+ OPENREVIEW_VENUE_ID=Your/Venue/ID
55
+ MAIL_FROM=Your Choice <your-choice@openreview.net>
56
+ ```
57
+
58
+ ### Usage
59
+
60
+ ```bash
61
+ ortler --help # Show all commands
62
+ ortler COMMAND --help # Show help for a specific command
63
+ ```
64
+
65
+ ## Commands
66
+
67
+ ### update
68
+
69
+ Sync venue data from OpenReview to a local cache. The cache enables fast queries and RDF export without repeated API calls.
70
+
71
+ ```bash
72
+ # Incremental update (only fetch changes since last update)
73
+ ortler update
74
+
75
+ # Preview what would be updated
76
+ ortler update --dry-run
77
+
78
+ # Force re-fetch of all submissions
79
+ ortler update --recache submissions
80
+
81
+ # Force re-fetch of all profiles with publications
82
+ ortler update --recache profiles-with-publications
83
+
84
+ # Force re-fetch of everything
85
+ ortler update --recache all
86
+ ```
87
+
88
+ ### dump
89
+
90
+ Export all cached data as RDF (Turtle format) for use with SPARQL engines like QLever.
91
+
92
+ ```bash
93
+ # Output to stdout
94
+ ortler dump
95
+
96
+ # Output to file
97
+ ortler dump --output data.ttl
98
+ ```
99
+
100
+ The RDF output includes triples for the following; just run it and inspect if
101
+ yourself, Turtle is quite readable for humans:
102
+ - Committee members (reviewers, area chairs, senior area chairs) with roles and status
103
+ - Submissions with titles, abstracts, authors, and status
104
+ - Profile data including affiliations and publications
105
+
106
+ ### recruitment
107
+
108
+ Manage committee membership (reviewers, area chairs, senior area chairs).
109
+
110
+ ```bash
111
+ # Search for a user and show their group memberships
112
+ ortler recruitment --search user@example.com
113
+ ortler recruitment --search ~John_Doe1
114
+
115
+ # Add users to the reviewer pool
116
+ ortler recruitment --role pc --add invited user1@example.com user2@example.com
117
+
118
+ # Remove a user from the invited list
119
+ ortler recruitment --role pc --remove invited user@example.com
120
+
121
+ # Set reduced review load for a member
122
+ ortler recruitment --role pc --set-reduced-load ~John_Doe1 2
123
+ ```
124
+
125
+ Roles: `pc` (reviewers), `spc` (area chairs), `ac` (senior area chairs)
126
+
127
+ ### mail
128
+
129
+ Send emails via the OpenReview API. Emails are defined in a file with headers and body separated by a blank line.
130
+
131
+ ```bash
132
+ # Preview email without sending
133
+ ortler mail message.txt --dry-run
134
+
135
+ # Send to a test recipient first
136
+ ortler mail message.txt --test-run ~Your_Profile1
137
+
138
+ # Send emails with recipients from a SPARQL query
139
+ ortler mail message.txt --recipients-from-sparql-query QUERY_HASH
140
+ ```
141
+
142
+ Example email file; the `{{name}}` placeholder will be replaced with the
143
+ recipient's first name if that information is available, otherwise the full
144
+ name.
145
+ ```
146
+ To: ~Recipient_Profile1 ~Recipient_Profile2 ...
147
+ Subject: Your subject line
148
+
149
+ Dear {{name}},
150
+
151
+ This is an email from the `ortler` tool, we hope that you like it!
152
+
153
+ Best regards,
154
+
155
+ The robots from the future
156
+ ```
157
+
158
+ Example with SPARQL query; the `{{name}}` placeholder will be replaced just
159
+ like above; the list of recipients is determined by the first column of the
160
+ query result, where all values are profile IRIs; other columns of the result
161
+ can be used as additional placeholders in the email body, where, for example,
162
+ `{{titles}}` will be replaced by the content of the `?titles` variable.
163
+ ```
164
+ # Query: https://qlever.dev/your-backend/QUERY_HASH
165
+ To: (will be replaced by profile IDs from query result)
166
+ Subject: Your submissions
167
+
168
+ Dear {{name}},
169
+
170
+ You have submitted the following papers, just so you know:
171
+
172
+ {{titles}}
173
+
174
+ Best regards ...
175
+ ```
176
+
177
+ ## Other Commands
178
+
179
+ Run `ortler --help` to see all available commands and `ortler COMMAND --help`
180
+ for details on each command.
ortler-0.2.4/README.md ADDED
@@ -0,0 +1,162 @@
1
+ # ortler
2
+
3
+ Ortler is a powerful and versatile command-line tool for managing OpenReview venues.
4
+ It provides commands for syncing venue data to a local cache, managing committee recruitment,
5
+ tracking submissions, and sending emails via the OpenReview API. It is named after OpenReview
6
+ and a beautiful mountain in the Alps.
7
+
8
+ <img width="1476" height="431" alt="image" src="https://github.com/user-attachments/assets/4298fc2f-16c4-489a-9a70-858fc03b65b3" />
9
+
10
+ ## Quickstart
11
+
12
+ ### Installation
13
+
14
+ ```bash
15
+ # Install with pipx (recommended)
16
+ pipx install git+https://github.com/ad-freiburg/ortler.git
17
+
18
+ # Or with pip in a virtual environment
19
+ python3 -m venv venv && source venv/bin/activate
20
+ pip install git+https://github.com/ad-freiburg/ortler.git
21
+
22
+ # Or install in editable mode for development
23
+ git clone git@github.com:ad-freiburg/ortler.git
24
+ cd ortler
25
+ pipx install -e .
26
+ ```
27
+
28
+ ### Configuration
29
+
30
+ Create a `.env` file with your OpenReview credentials (see `.env.example`):
31
+
32
+ ```bash
33
+ OPENREVIEW_API_URL=https://api2.openreview.net
34
+ OPENREVIEW_USERNAME=your.email@example.com
35
+ OPENREVIEW_PASSWORD=your-password
36
+ OPENREVIEW_VENUE_ID=Your/Venue/ID
37
+ MAIL_FROM=Your Choice <your-choice@openreview.net>
38
+ ```
39
+
40
+ ### Usage
41
+
42
+ ```bash
43
+ ortler --help # Show all commands
44
+ ortler COMMAND --help # Show help for a specific command
45
+ ```
46
+
47
+ ## Commands
48
+
49
+ ### update
50
+
51
+ Sync venue data from OpenReview to a local cache. The cache enables fast queries and RDF export without repeated API calls.
52
+
53
+ ```bash
54
+ # Incremental update (only fetch changes since last update)
55
+ ortler update
56
+
57
+ # Preview what would be updated
58
+ ortler update --dry-run
59
+
60
+ # Force re-fetch of all submissions
61
+ ortler update --recache submissions
62
+
63
+ # Force re-fetch of all profiles with publications
64
+ ortler update --recache profiles-with-publications
65
+
66
+ # Force re-fetch of everything
67
+ ortler update --recache all
68
+ ```
69
+
70
+ ### dump
71
+
72
+ Export all cached data as RDF (Turtle format) for use with SPARQL engines like QLever.
73
+
74
+ ```bash
75
+ # Output to stdout
76
+ ortler dump
77
+
78
+ # Output to file
79
+ ortler dump --output data.ttl
80
+ ```
81
+
82
+ The RDF output includes triples for the following; just run it and inspect if
83
+ yourself, Turtle is quite readable for humans:
84
+ - Committee members (reviewers, area chairs, senior area chairs) with roles and status
85
+ - Submissions with titles, abstracts, authors, and status
86
+ - Profile data including affiliations and publications
87
+
88
+ ### recruitment
89
+
90
+ Manage committee membership (reviewers, area chairs, senior area chairs).
91
+
92
+ ```bash
93
+ # Search for a user and show their group memberships
94
+ ortler recruitment --search user@example.com
95
+ ortler recruitment --search ~John_Doe1
96
+
97
+ # Add users to the reviewer pool
98
+ ortler recruitment --role pc --add invited user1@example.com user2@example.com
99
+
100
+ # Remove a user from the invited list
101
+ ortler recruitment --role pc --remove invited user@example.com
102
+
103
+ # Set reduced review load for a member
104
+ ortler recruitment --role pc --set-reduced-load ~John_Doe1 2
105
+ ```
106
+
107
+ Roles: `pc` (reviewers), `spc` (area chairs), `ac` (senior area chairs)
108
+
109
+ ### mail
110
+
111
+ Send emails via the OpenReview API. Emails are defined in a file with headers and body separated by a blank line.
112
+
113
+ ```bash
114
+ # Preview email without sending
115
+ ortler mail message.txt --dry-run
116
+
117
+ # Send to a test recipient first
118
+ ortler mail message.txt --test-run ~Your_Profile1
119
+
120
+ # Send emails with recipients from a SPARQL query
121
+ ortler mail message.txt --recipients-from-sparql-query QUERY_HASH
122
+ ```
123
+
124
+ Example email file; the `{{name}}` placeholder will be replaced with the
125
+ recipient's first name if that information is available, otherwise the full
126
+ name.
127
+ ```
128
+ To: ~Recipient_Profile1 ~Recipient_Profile2 ...
129
+ Subject: Your subject line
130
+
131
+ Dear {{name}},
132
+
133
+ This is an email from the `ortler` tool, we hope that you like it!
134
+
135
+ Best regards,
136
+
137
+ The robots from the future
138
+ ```
139
+
140
+ Example with SPARQL query; the `{{name}}` placeholder will be replaced just
141
+ like above; the list of recipients is determined by the first column of the
142
+ query result, where all values are profile IRIs; other columns of the result
143
+ can be used as additional placeholders in the email body, where, for example,
144
+ `{{titles}}` will be replaced by the content of the `?titles` variable.
145
+ ```
146
+ # Query: https://qlever.dev/your-backend/QUERY_HASH
147
+ To: (will be replaced by profile IDs from query result)
148
+ Subject: Your submissions
149
+
150
+ Dear {{name}},
151
+
152
+ You have submitted the following papers, just so you know:
153
+
154
+ {{titles}}
155
+
156
+ Best regards ...
157
+ ```
158
+
159
+ ## Other Commands
160
+
161
+ Run `ortler --help` to see all available commands and `ortler COMMAND --help`
162
+ for details on each command.
@@ -0,0 +1,29 @@
1
+ [project]
2
+ name = "ortler"
3
+ version = "0.2.4"
4
+ readme = "README.md"
5
+ requires-python = ">=3.10"
6
+ dependencies = [
7
+ "openreview-py",
8
+ "argcomplete",
9
+ "numpy",
10
+ "openai",
11
+ "pdf2image",
12
+ "reportlab",
13
+ "python-dotenv",
14
+ "termcolor",
15
+ ]
16
+
17
+ [project.urls]
18
+ Homepage = "https://github.com/ad-freiburg/ortler"
19
+ Repository = "https://github.com/ad-freiburg/ortler"
20
+
21
+ [project.scripts]
22
+ ortler = "ortler.main:main"
23
+
24
+ [build-system]
25
+ requires = ["setuptools>=61.0"]
26
+ build-backend = "setuptools.build_meta"
27
+
28
+ [tool.setuptools.packages.find]
29
+ where = ["src"]
ortler-0.2.4/setup.cfg ADDED
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,3 @@
1
+ """A command-line tool for managing OpenReview venues."""
2
+
3
+ __version__ = "0.1.0"