Skip to content

Commit 689afc9

Browse files
fix docs in v2.1.4
1 parent 38477ca commit 689afc9

File tree

59 files changed

+10242
-8265
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+10242
-8265
lines changed

README.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ You can use the tag *robotframework-ide* to search and ask on https://stackoverf
2222

2323
== **Welcome to the development version of RIDE - next major release will be version 2.2**
2424

25-
If you are looking for the latest released version, you can get the source code from **https://github.com/robotframework/RIDE/releases[releases]** or from branch **https://github.com/robotframework/RIDE/tree/release/2.1.3[release/2.1.3]**
25+
If you are looking for the latest released version, you can get the source code from **https://github.com/robotframework/RIDE/releases[releases]** or from branch **https://github.com/robotframework/RIDE/tree/release/2.1.4[release/2.1.4]**
2626

27-
See the https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.1.3.rst[release notes] for latest release version 2.1.3
27+
See the https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.1.4.rst[release notes] for latest release version 2.1.4
2828

2929
**Version https://github.com/robotframework/RIDE/tree/release/2.0.8.1[2.0.8.1] was the last release supporting Python 3.6 and 3.7**
3030

@@ -37,11 +37,11 @@ Currently, the unit tests are tested on Python 3.10, 3.11 and 3.13 (3.13 is the
3737
We now have an experimental workflow on Fedora Linux 41, with wxPython 4.2.3 and Python 3.14.a7.
3838
Likewise, the current version of wxPython, is 4.2.3, but RIDE is known to work with 4.0.7, 4.1.1 and 4.2.2 versions.
3939

40-
(3.8 <= python <= 3.13) Install current released version (*2.1.3*) with:
40+
(3.8 <= python <= 3.13) Install current released version (*2.1.4*) with:
4141

4242
`pip install -U robotframework-ride`
4343

44-
(3.8 <= python <= 3.13) Install current development version (**2.2dev31**) with:
44+
(3.8 <= python <= 3.13) Install current development version (**2.2dev32**) with:
4545

4646
`pip install -U https://github.com/robotframework/RIDE/archive/develop.zip`
4747

README.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# RIDE
2+
3+
RIDE is an IDE (Integrated Development Environment) exclusive for [Robot Framework](https://robotframework.org) tests or tasks automation framework.
4+
5+
----
6+
7+
Robot Framework supports, since version 6.1, files with localized definitions. RIDE was updated to accept those files, and we are working on a localization project to have its GUI in the same languages supported by Robot Framework.
8+
You can help in this localization project at [Crowdin](https://crowdin.com/project/robotframework-ride) [![Crowdin](https://badges.crowdin.net/robotframework-ride/localized.svg)](https://crowdin.com/project/robotframework-ride)
9+
10+
11+
### Instant Communication
12+
13+
Join our **#ride** channel in Robot Framework Slack: https://robotframework.slack.com
14+
(signup page, with insecure connection warning: https://slack.robotframework.org/)
15+
16+
### "Support" sites
17+
18+
We have a RIDE section topic in [Tools>RIDE](https://forum.robotframework.org/c/tools/ride/21).
19+
20+
You can use the tag *robotframework-ide* to search and ask on [StackOverflow](https://stackoverflow.com/questions/tagged/robotframework-ide).
21+
22+
## **Welcome to RIDE - next major release will be version 2.2**
23+
24+
If you are looking for the latest released version, you can get the source code from **[releases](https://github.com/robotframework/RIDE/releases)** or from branch **[release/2.1.4](https://github.com/robotframework/RIDE/tree/release/2.1.4)**
25+
26+
See the [release notes](https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.1.4.rst) for latest release version 2.1.4
27+
28+
**Version [2.0.8.1](https://github.com/robotframework/RIDE/tree/release/2.0.8.1) was the last release supporting Python 3.6 and 3.7**
29+
30+
**Version [1.7.4.2](https://github.com/robotframework/RIDE/tree/release/1.7.4.2) was the last release supporting Python 2.7**
31+
32+
33+
**The current development version is based on 2.1.3, supports Python from 3.8 up to 3.14 (20th June 2025).**
34+
35+
Currently, the unit tests are tested on Python 3.10, 3.11 and 3.13 (3.13 is the recommended version).
36+
We now have an experimental workflow on Fedora Linux 41, with wxPython 4.2.3 and Python 3.14.a7.
37+
Likewise, the current version of wxPython, is 4.2.3, but RIDE is known to work with 4.0.7, 4.1.1 and 4.2.2 versions.
38+
39+
(3.8 <= python <= 3.14) Install current released version (*2.1.4*) with:
40+
41+
`pip install -U robotframework-ride`
42+
43+
(3.8 <= python <= 3.14) Install current development version (**2.2dev??**) with:
44+
45+
`pip install -U https://github.com/robotframework/RIDE/archive/develop.zip`
46+
47+
**See the [FAQ](https://github.com/robotframework/RIDE/wiki/F%2eA%2eQ%2e) at [Wiki](https://github.com/robotframework/RIDE/wiki)**
48+
49+
50+
51+
## Unit testing statuses:
52+
53+
Linux (Fedora 41: py3.13, Ubuntu 22.04: py3.10): [[!Linux](https://img.shields.io/github/actions/workflow/status/HelioGuilherme66/RIDE/linux.yml)](https://github.com/HelioGuilherme66/RIDE/actions/workflows/linux.yml)
54+
55+
Windows (Python 3.11): [[!Windows](https://ci.appveyor.com/api/projects/status/github/HelioGuilherme66/RIDE?branch=master&svg=true)](https://ci.appveyor.com/project/HelioGuilherme66/ride)
56+
57+
Quality Gate Status: [[!Sonar](https://sonarcloud.io/api/project_badges/measure?project=HelioGuilherme66_RIDE&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=HelioGuilherme66_RIDE)
58+
59+
----
60+
### Links
61+
62+
* [Localization at Crowdin](https://crowdin.com/project/robotframework-ride)
63+
* [Downloads at PyPi](https://pypi.python.org/pypi/robotframework-ride)
64+
* Statistics at [PyPi Stats](https://pypistats.org/packages/robotframework-ride) and [Libraries.io](https://libraries.io/pypi/robotframework-ride)
65+
* Usage instructions and some tips and tricks can be found from the [Wiki](https://github.com/robotframework/RIDE/wiki)
66+
* Bug report/enhancement request? Use the [issue tracker](https://github.com/robotframework/RIDE/issues)
67+
* Any questions? Do not hesitate to use the [mailing list](https://groups.google.com/group/robotframework-users/), or [Robot Framework Forum->Tools>RIDE](https://forum.robotframework.org/c/tools/ride/21), or [StackOverflow](https://stackoverflow.com/questions/tagged/robotframework-ide).
68+
* Development information is in [BUILD](https://github.com/robotframework/RIDE/blob/master/BUILD.rest) file
69+
70+
---
71+
72+
## Stargazers over time
73+
74+
[[!Stargazers over time](https://starchart.cc/robotframework/RIDE.svg)]

pyproject.toml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@ build-backend = "hatchling.build"
66
name = "robotframework-ride"
77
dynamic = ["version"]
88
description = "RIDE :: Robot Framework Test Data Editor"
9+
long_description = """
10+
Robot Framework is a generic test automation framework for acceptance
11+
level testing. RIDE is a lightweight and intuitive editor for Robot
12+
Framework test data.
13+
14+
Project: https://github.com/robotframework/RIDE#readme
15+
"""
16+
long_description_content_type = "text/x-rst"
917
license = "Apache-2.0"
1018
license-files = { paths = ["LICENSE.txt"] }
1119
requires-python = ">=3.8, <3.15"

setup.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,11 @@
6565
Project: https://github.com/robotframework/RIDE#readme
6666
""".strip()
6767

68+
# read the contents of your README file
69+
from pathlib import Path
70+
this_directory = Path(__file__).parent
71+
long_description_full = (this_directory / "README.md").read_text()
72+
6873
CLASSIFIERS = """
6974
Development Status :: 5 - Production/Stable
7075
License :: OSI Approved :: Apache Software License
@@ -100,7 +105,7 @@ def run(self):
100105
name='robotframework-ride',
101106
version=main_ns['VERSION'],
102107
description='RIDE :: Robot Framework Test Data Editor',
103-
long_description=LONG_DESCRIPTION,
108+
long_description=long_description_full,
104109
long_description_content_type='text/markdown',
105110
license='Apache License 2.0',
106111
keywords='robotframework testing testautomation',

src/robotide/localization/RIDE.pot

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
msgid ""
66
msgstr ""
77
"Project-Id-Version: PACKAGE VERSION\n"
8-
"POT-Creation-Date: 2025-06-16 00:40+0100\n"
8+
"POT-Creation-Date: 2025-06-20 19:52+0100\n"
99
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1010
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1111
"Language-Team: LANGUAGE <LL@li.org>\n"
@@ -1250,7 +1250,7 @@ msgstr ""
12501250
msgid "Make Dict Variable\tCtrl-5"
12511251
msgstr ""
12521252

1253-
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:950
1253+
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:951
12541254
msgid ""
12551255
"<b>Keyword was not detected by RIDE</b>\n"
12561256
" <br>Possible corrections:<br>\n"
@@ -1264,51 +1264,51 @@ msgid ""
12641264
" </ul>"
12651265
msgstr ""
12661266

1267-
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1101
1267+
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1102
12681268
#: /home2/helio/github/RIDE/tools/../src/robotide/ui/mainframe.py:200
12691269
#: /home2/helio/github/RIDE/tools/../src/robotide/ui/treenodehandlers.py:234
12701270
#: /home2/helio/github/RIDE/tools/../src/robotide/ui/treeplugin.py:1216
12711271
msgid "Validation Error"
12721272
msgstr ""
12731273

1274-
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1188
1274+
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1189
12751275
msgid "New name"
12761276
msgstr ""
12771277

1278-
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1201
1278+
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1202
12791279
msgid "Save"
12801280
msgstr ""
12811281

1282-
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1204
1282+
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1205
12831283
#: /home2/helio/github/RIDE/tools/../src/robotide/widgets/dialog.py:133
12841284
msgid "Cancel"
12851285
msgstr ""
12861286

1287-
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1234
1287+
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1235
12881288
msgid "Validation Error!"
12891289
msgstr ""
12901290

1291-
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1235
1291+
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1236
12921292
msgid "Error in JSON:"
12931293
msgstr ""
12941294

1295-
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1235
1295+
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1236
12961296
msgid "Save anyway?"
12971297
msgstr ""
12981298

1299-
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1405
1299+
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1406
13001300
msgid "Please select what you want to check for usage"
13011301
msgstr ""
13021302

1303-
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1408
1303+
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1409
13041304
msgid "Complete cell content"
13051305
msgstr ""
13061306

1307-
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1409
1307+
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1410
13081308
msgid "Variable "
13091309
msgstr ""
13101310

1311-
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1421
1311+
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/kweditor.py:1422
13121312
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/texteditor.py:1110
13131313
#: /home2/helio/github/RIDE/tools/../src/robotide/editor/texteditor.py:1112
13141314
#: /home2/helio/github/RIDE/tools/../src/robotide/searchtests/dialogsearchtests.py:49
Binary file not shown.

0 commit comments

Comments
 (0)