Skip to content

Commit

Permalink
chore: Update README (#1041)
Browse files Browse the repository at this point in the history
  • Loading branch information
edgarrmondragon authored Nov 29, 2023
1 parent 5eccb94 commit 4f371a8
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 29 deletions.
4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ message: "If you use this software, please cite it as below."
authors:
- family-names: "Ramírez Mondragón"
given-names: "Edgar"
orcid: "https://orcid.org/0000-0000-0000-0000"
title: "My Research Software"
orcid: "https://orcid.org/0000-0002-4182-0385"
title: "Citric"
version: "0.10.0"
doi: 10.5281/zenodo.1234
date-released: 2021-11-11
Expand Down
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,6 @@
<a href="https://codecov.io/gh/edgarrmondragon/citric">
<img alt="codecov" src="https://codecov.io/gh/edgarrmondragon/citric/branch/main/graph/badge.svg"/>
</a>
<a href="https://app.fossa.com/projects/git%2Bgithub.com%2Fedgarrmondragon%2Fcitric?ref=badge_shield">
<img alt="FOSSA Status" src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fedgarrmondragon%2Fcitric.svg?type=shield"/>
</a>
</div>

<div>
Expand Down Expand Up @@ -108,10 +105,9 @@ If you'd like to contribute to this project, please see the [contributing guide]

## Credits

- [Markus Opolka][martialblog] for maintaining a very robust set of [LimeSurvey Docker images](https://github.com/martialblog/docker-limesurvey/).
- [Claudio Jolowicz][claudio] and [his amazing blog post][hypermodern].

[claudio]: https://twitter.com/cjolowicz/
[hypermodern]: https://cjolowicz.github.io/posts/hypermodern-python-01-setup/

## License
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fedgarrmondragon%2Fcitric.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fedgarrmondragon%2Fcitric?ref=badge_large)
[martialblog]: https://github.com/martialblog/
16 changes: 9 additions & 7 deletions docs/contributing/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Ready to contribute? Here's how to set up `citric` for local development.

```shell
git clone https://github.com/edgarrmondragon/citric.git
cd citric
```

1. Install [`poetry`][poetry] and the `poetry-dynamic-versioning` plugin:
Expand All @@ -33,12 +34,6 @@ Ready to contribute? Here's how to set up `citric` for local development.
nox -l
```

1. To check that your changes pass the project style checks, use [`pre-commit`][pre-commit]:

```shell
pre-commit install
```

1. Create a branch for local development:

```shell
Expand All @@ -47,6 +42,13 @@ Ready to contribute? Here's how to set up `citric` for local development.

Now you can make your changes locally.

1. To check that your changes pass the project style checks, use [`pre-commit`][pre-commit]:

```shell
pre-commit install
pre-commit run --all-files
```

1. Commit your changes and push your branch to GitHub:

```shell
Expand All @@ -57,7 +59,7 @@ Ready to contribute? Here's how to set up `citric` for local development.

1. Submit a pull request through the GitHub website.

1. (Optional) Add a changelog entry using [`changie`][changie]. You'll need to install the Change CLI in order to add a changelog entry:
1. (Optional) Add a changelog entry using [`changie`][changie]. You'll need to install the Changie CLI in order to add a changelog entry:
```shell
changie new
Expand Down
6 changes: 3 additions & 3 deletions docs/contributing/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,19 @@ you can follow the [Docker guide][docker].
### Doctests

```shell
nox -rs xdoctest -p 3.12
nox -rs xdoctest -p "3.12"
```

### Type checking

```shell
nox -rs mypy -p 3.12
nox -rs mypy -p "3.12"
```

### Dependency checks

```shell
nox -rs deps -p 3.12
nox -rs deps -p "3.12"
```

[environment]: /contributing/environment
Expand Down
5 changes: 2 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,12 @@ classifiers = [
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"Intended Audience :: Information Technology",
"Intended Audience :: Science/Research",
"Intended Audience :: System Administrators",
"License :: OSI Approved :: MIT License",
"Natural Language :: English",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3.13",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
"Topic :: Software Development :: Libraries :: Python Modules",
"Typing :: Typed",
]
description = "A client to the LimeSurvey Remote Control API 2, written in modern Python."
Expand All @@ -27,6 +25,7 @@ version = "0.0.0"

[tool.poetry.urls]
"Issue Tracker" = "https://github.com/edgarrmondragon/citric/issues"
"Changelog" = "https://github.com/edgarrmondragon/citric/blob/main/CHANGELOG.md"

[tool.poetry.dependencies]
python = ">=3.8"
Expand Down
8 changes: 0 additions & 8 deletions tests/resources/config.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,6 @@
),
'request' => array(
'baseUrl' => '',
// TODO: Remove 'noCsrfValidationRoutes' this once it's fixed upstream
// https://github.com/LimeSurvey/LimeSurvey/pull/3599
'enableCsrfValidation' => true,
'noCsrfValidationRoutes' => array(
'rest',
'admin/remotecontrol',
'plugins/unsecure',
),
),
),
'config' => array(
Expand Down

0 comments on commit 4f371a8

Please sign in to comment.