Skip to content

Commit 3f91a1d

Browse files
bigcat88bigcat88
authored
Updating Repository Stuff (#43)
Signed-off-by: Alexander Piskun <[email protected]>
1 parent 707f1f1 commit 3f91a1d

File tree

7 files changed

+127
-15
lines changed

7 files changed

+127
-15
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Bug Report
2+
description: Create a report to help reproduce and correct the bug
3+
labels: ['Bug', 'Needs Triage']
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
#### Before submitting a bug, please make sure the issue hasn't been already
10+
addressed by searching through [the past issues](https://github.com/cloud-py-api/nc_py_api/issues).
11+
- type: textarea
12+
attributes:
13+
label: Describe the bug
14+
description: >
15+
A clear and concise description of what the bug is.
16+
validations:
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Steps/Code to Reproduce
21+
description: |
22+
Please add a minimal code example that can reproduce the error when running it. Be as succinct as possible.
23+
24+
If the code is too long, feel free to put it in a public gist and link it in the issue: https://gist.github.com.
25+
26+
placeholder: |
27+
```
28+
Sample code to reproduce the problem
29+
```
30+
validations:
31+
required: true
32+
- type: textarea
33+
attributes:
34+
label: Expected Results
35+
description: >
36+
Please paste or describe the expected results.
37+
placeholder: >
38+
Example: No error is thrown.
39+
validations:
40+
required: true
41+
- type: textarea
42+
attributes:
43+
label: Actual Results
44+
description: |
45+
Please paste or describe the results you observe instead of the expected results. If you observe an error, please paste the error message including the **full traceback** of the exception.
46+
placeholder: >
47+
Please paste or specifically describe the actual output or traceback.
48+
validations:
49+
required: true
50+
- type: textarea
51+
attributes:
52+
label: Setup configuration
53+
description: |
54+
Paste or describe the configuration setting, including software versions, to help diagnose the problem more quickly.
55+
placeholder: >
56+
Example: nc_py_apy = 0.15.0, nextcloud = 28.0.4, etc.
57+
validations:
58+
required: true
59+
- type: markdown
60+
attributes:
61+
value: >
62+
Thanks for contributing 🎉!

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Discussions
4+
url: https://github.com/cloud-py-api/nc_py_api/discussions/new
5+
about: Ask questions and discuss
6+
- name: Blank issue
7+
url: https://github.com/cloud-py-api/nc_py_api/issues/new
8+
about: Please note that Github Discussions should be used in most cases instead

‎.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Feature request
2+
description: Suggest a new feature, enhancement to an existing, etc.
3+
labels: ['New Feature', 'Needs Triage']
4+
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Describe why it is important and where it will be useful
9+
validations:
10+
required: true
11+
- type: textarea
12+
attributes:
13+
label: Describe your proposed solution
14+
validations:
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: Describe alternatives you've considered, if relevant
19+
- type: textarea
20+
attributes:
21+
label: Additional context

‎AUTHORS

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Here is an inevitably incomplete list of MUCH-APPRECIATED CONTRIBUTORS --
2+
people who have submitted patches, reported bugs, added translations, helped
3+
answer newbie questions, and generally made NC-Py-API that much better:
4+
5+
Andrey Borysenko <[email protected]>
6+
Alexander Piskun <[email protected]>
7+
<Please alphabetize new entries>
8+
9+
A big THANK YOU goes to:
10+
11+
All Nextcloud community.
12+
All Python community.
13+
14+
Guido van Rossum for creating Python.

‎CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22

33
All notable changes to this project will be documented in this file.
44

5-
## [0.0.25 - 2023-07-xx]
5+
## [0.0.25 - 2023-07-25]
6+
7+
### Added
8+
9+
- First `Files Sharing` APIs.
610

711
### Changed
812

‎MANIFEST.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
include nc_py_api/*
2+
include AUTHORS
23
include README.md
34
include CHANGELOG.md
45
include pyproject.toml

‎README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,42 +9,44 @@
99
![impl](https://img.shields.io/pypi/implementation/nc_py_api)
1010
![pypi](https://img.shields.io/pypi/v/nc_py_api.svg)
1111

12-
### Remark
13-
14-
Project cloud-py-api was **abandoned** and divided into two parts:
15-
* `nc_py_api` - this repository, which contains Python Framework to work with Nextcloud and `app_ecosystem_v2`
16-
* `app_ecosystem_v2` - New [Nextcloud Application Ecosystem](https://github.com/cloud-py-api/app_ecosystem_v2) that allows writing applications for Nextcloud in any language
17-
18-
**_Projects stage: under heavy prototyping and developing_**
12+
Python library that provides a robust and well-documented API that allows developers to interact with and extend Nextcloud's functionality.
1913

2014
### Basic Features:
21-
* Listing, enabling and disabling of the applications
2215
* Operations with Files and Folders
2316
* ~~Operations with Trash bin and File versions~~
2417
* Operations with Users and User Groups
25-
* User status manipulation
18+
* User status
2619
* Weather status
2720
* ~~Nextcloud notifications support~~
2821
* Shares support
2922
* ~~Talk support~~
3023

31-
### Extended Features with installed App_ecosystem_v2:
32-
* Defining callback routes with FastAPI for Nextcloud
24+
### Extended Features with AppEcosystemV2:
25+
* Defining callback routes with `FastAPI` for Nextcloud
3326
* Registering UI elements in Nextcloud
3427
* Storing logs to the `nextcloud.log` file
3528
* Get/save key-value pairs in AppConfigEx/PreferencesEx tables.
3629
* **Tons of the cool stuff that is coming soon**
3730

31+
### Support
32+
33+
You can support us in several ways:
34+
35+
- ⭐️ Star our work (it really motivates)
36+
- ❗️ Create an Issue or feature request (bring to us an excellent idea)
37+
- 💁 Resolve some Issue or create a Pull Request (contribute to this project)
38+
- 🙏 Write an example of its use or correct a typo in the documentation.
39+
3840
### 🚀 How to start
3941

40-
In very close near future we will publish examples
42+
In a very close near future we will publish examples
4143

4244
### More Information
4345

44-
- [Documentation](https://nc_py_api.readthedocs.io/)
46+
- [Documentation](https://cloud-py-api.github.io/nc_py_api/)
4547
- [Using it as a simple client](to-do)
4648
- [Writing a simple Nextcloud application](to-do)
47-
- [Writing a Nextcloud system application](to-do)
49+
- [Writing a Nextcloud System Application](to-do)
4850
- [Examples](https://github.com/cloud-py-api/nc_py_api/tree/main/examples)
4951
- [Contribute](https://github.com/cloud-py-api/nc_py_api/blob/main/.github/CONTRIBUTING.md)
5052
- [Discussions](https://github.com/cloud-py-api/nc_py_api/discussions)

0 commit comments

Comments
 (0)