Skip to content

Commit

Permalink
Updating Repository Stuff (#43)
Browse files Browse the repository at this point in the history
Signed-off-by: Alexander Piskun <bigcat88@icloud.com>
  • Loading branch information
bigcat88 authored Jul 24, 2023
1 parent 707f1f1 commit 3f91a1d
Show file tree
Hide file tree
Showing 7 changed files with 127 additions and 15 deletions.
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Bug Report
description: Create a report to help reproduce and correct the bug
labels: ['Bug', 'Needs Triage']

body:
- type: markdown
attributes:
value: >
#### Before submitting a bug, please make sure the issue hasn't been already
addressed by searching through [the past issues](https://github.com/cloud-py-api/nc_py_api/issues).
- type: textarea
attributes:
label: Describe the bug
description: >
A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
attributes:
label: Steps/Code to Reproduce
description: |
Please add a minimal code example that can reproduce the error when running it. Be as succinct as possible.
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.
placeholder: |
```
Sample code to reproduce the problem
```
validations:
required: true
- type: textarea
attributes:
label: Expected Results
description: >
Please paste or describe the expected results.
placeholder: >
Example: No error is thrown.
validations:
required: true
- type: textarea
attributes:
label: Actual Results
description: |
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.
placeholder: >
Please paste or specifically describe the actual output or traceback.
validations:
required: true
- type: textarea
attributes:
label: Setup configuration
description: |
Paste or describe the configuration setting, including software versions, to help diagnose the problem more quickly.
placeholder: >
Example: nc_py_apy = 0.15.0, nextcloud = 28.0.4, etc.
validations:
required: true
- type: markdown
attributes:
value: >
Thanks for contributing 🎉!
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Discussions
url: https://github.com/cloud-py-api/nc_py_api/discussions/new
about: Ask questions and discuss
- name: Blank issue
url: https://github.com/cloud-py-api/nc_py_api/issues/new
about: Please note that Github Discussions should be used in most cases instead
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Feature request
description: Suggest a new feature, enhancement to an existing, etc.
labels: ['New Feature', 'Needs Triage']

body:
- type: textarea
attributes:
label: Describe why it is important and where it will be useful
validations:
required: true
- type: textarea
attributes:
label: Describe your proposed solution
validations:
required: true
- type: textarea
attributes:
label: Describe alternatives you've considered, if relevant
- type: textarea
attributes:
label: Additional context
14 changes: 14 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Here is an inevitably incomplete list of MUCH-APPRECIATED CONTRIBUTORS --
people who have submitted patches, reported bugs, added translations, helped
answer newbie questions, and generally made NC-Py-API that much better:

Andrey Borysenko <andrey18106x@gmail.com>
Alexander Piskun <bigcat88@icloud.com>
<Please alphabetize new entries>

A big THANK YOU goes to:

All Nextcloud community.
All Python community.

Guido van Rossum for creating Python.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

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

## [0.0.25 - 2023-07-xx]
## [0.0.25 - 2023-07-25]

### Added

- First `Files Sharing` APIs.

### Changed

Expand Down
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
include nc_py_api/*
include AUTHORS
include README.md
include CHANGELOG.md
include pyproject.toml
Expand Down
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,42 +9,44 @@
![impl](https://img.shields.io/pypi/implementation/nc_py_api)
![pypi](https://img.shields.io/pypi/v/nc_py_api.svg)

### Remark

Project cloud-py-api was **abandoned** and divided into two parts:
* `nc_py_api` - this repository, which contains Python Framework to work with Nextcloud and `app_ecosystem_v2`
* `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

**_Projects stage: under heavy prototyping and developing_**
Python library that provides a robust and well-documented API that allows developers to interact with and extend Nextcloud's functionality.

### Basic Features:
* Listing, enabling and disabling of the applications
* Operations with Files and Folders
* ~~Operations with Trash bin and File versions~~
* Operations with Users and User Groups
* User status manipulation
* User status
* Weather status
* ~~Nextcloud notifications support~~
* Shares support
* ~~Talk support~~

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

### Support

You can support us in several ways:

- ⭐️ Star our work (it really motivates)
- ❗️ Create an Issue or feature request (bring to us an excellent idea)
- 💁 Resolve some Issue or create a Pull Request (contribute to this project)
- 🙏 Write an example of its use or correct a typo in the documentation.

### 🚀 How to start

In very close near future we will publish examples
In a very close near future we will publish examples

### More Information

- [Documentation](https://nc_py_api.readthedocs.io/)
- [Documentation](https://cloud-py-api.github.io/nc_py_api/)
- [Using it as a simple client](to-do)
- [Writing a simple Nextcloud application](to-do)
- [Writing a Nextcloud system application](to-do)
- [Writing a Nextcloud System Application](to-do)
- [Examples](https://github.com/cloud-py-api/nc_py_api/tree/main/examples)
- [Contribute](https://github.com/cloud-py-api/nc_py_api/blob/main/.github/CONTRIBUTING.md)
- [Discussions](https://github.com/cloud-py-api/nc_py_api/discussions)
Expand Down

0 comments on commit 3f91a1d

Please sign in to comment.