| Name | team-task-manager JSON |
| Version |
0.0.0
JSON |
| download |
| home_page | https://github.com/a-yh-chew/team-task-manager.git |
| Summary | This is a simple task management system small businesses can use. |
| upload_time | 2024-03-09 15:54:31 |
| maintainer | |
| docs_url | None |
| author | a-yh-chew |
| requires_python | >=3.12 |
| license | MIT License Copyright (c) 2024, Angela Chew Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
team
small business
task manager
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# team-task-manager
This is a simple task management system small businesses can use.
## In this README
- Requirements
- Installation
- How it works
- Contributing
- Author
- License
## Requirements
#### Before you continue, ensure you have met the following requirements:
- Python 3.12 or newer is recommended.
- pip 24.0 or newer is recommended.
- setuptools 69.1.1 or newer is recommended.
- You are using a Windows OS. Linux and Mac OS are not currently supported.
#### Extra requirements:
- pytest 8.0.2 or newer is recommended.
- twine 5.0.0 or newer is recommended.
A full list of the required packages and their respective dependencies can be found in the **requirements.txt** file of this project's [GitHub repository](https://github.com/a-yh-chew/team-task-manager).
## Installation
If you don't have Python installed on your system, see [here](https://wiki.python.org/moin/BeginnersGuide/Download) for instructions of how to do this. Make sure your version of Python is 3.12 or newer.
From Python version 3.4 onwards pip is included by default. With Python and pip you can open a terminal and use pip-commands to install packages.
###
1. It's recommended to create a virtual environment (see [here](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/) for instructions of how to do this) to house the team-task-manager package and its package dependencies, though this is optional.
####
2. Make sure that your environment has all the required packages installed.
####
3. Next, run the installation syntax presented at the top of [https://pypi.org/project/team-task-manager/](https://pypi.org/project/team-task-manager/) starting with 'pip install'.
####
4. Once the team-task-manager package and the required packages are installed in your environment, assuming you have followed a process resembling the one [here](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/), you should be able to locate team_task_manager.py through the path:
~~~
project_directory\.venv\Lib\site-packages\team-task-manager\team_task_manager.py
~~~
####
5. Open and run team_task_manager.py in your preferred IDE to use the team-task-manager, operated through inputs to the console.
## How it works
#### When team_task_manager.py is run the following files are generated:
- users.txt - Containing user login information.
- tasks.txt - Containing tasks records.
---
#### After logging in with the default admin credentials:
- username = admin
- password = password
#### The following features are available to the admin:
- Registering new users
- Assigning a new task to a user
- Viewing and modifying all tasks on the system
- Viewing and modifying all tasks assigned to the current user (in this case the admin)
- Generating summary reports as text files
- Displaying the summary reports in the console
- Changing login credentials (though the admin can only change their password)
- Exiting the program
---
#### After the admin has registered new users, the following features are available to non-admin users:
- Registering new users
- Assigning a new task to a user
- Viewing all tasks on the system
- Viewing and modifying all tasks assigned to the current user
- Changing login credentials
- Exiting the program
## Contributing
If you find a bug, have ideas for new features, other improvements, or require more clarity on this project please submit an [issue](https://github.com/a-yh-chew/team-task-manager/issues).
## Author
Angela Chew (GitHub: [a-yh-chew](https://github.com/a-yh-chew), E-mail: a.yh.chew@gmail.com)
## License
[MIT](https://choosealicense.com/licenses/mit/)
Raw data
{
"_id": null,
"home_page": "https://github.com/a-yh-chew/team-task-manager.git",
"name": "team-task-manager",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": "a-yh-chew <a.yh.chew@gmail.com>",
"keywords": "team,small business,task manager",
"author": "a-yh-chew",
"author_email": "a-yh-chew <a.yh.chew@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/41/e0/b496e0c00906fb8326111578edeb7a702065ee9a959d2315963ff3b56893/team_task_manager-0.0.0.tar.gz",
"platform": null,
"description": "# team-task-manager\r\n\r\nThis is a simple task management system small businesses can use.\r\n\r\n\r\n## In this README\r\n- Requirements\r\n- Installation\r\n- How it works\r\n- Contributing\r\n- Author\r\n- License\r\n## Requirements\r\n#### Before you continue, ensure you have met the following requirements:\r\n- Python 3.12 or newer is recommended.\r\n- pip 24.0 or newer is recommended.\r\n- setuptools 69.1.1 or newer is recommended.\r\n- You are using a Windows OS. Linux and Mac OS are not currently supported.\r\n\r\n#### Extra requirements:\r\n- pytest 8.0.2 or newer is recommended.\r\n- twine 5.0.0 or newer is recommended.\r\n\r\nA full list of the required packages and their respective dependencies can be found in the **requirements.txt** file of this project's [GitHub repository](https://github.com/a-yh-chew/team-task-manager).\r\n## Installation\r\nIf you don't have Python installed on your system, see [here](https://wiki.python.org/moin/BeginnersGuide/Download) for instructions of how to do this. Make sure your version of Python is 3.12 or newer.\r\n\r\nFrom Python version 3.4 onwards pip is included by default. With Python and pip you can open a terminal and use pip-commands to install packages.\r\n###\r\n1. It's recommended to create a virtual environment (see [here](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/) for instructions of how to do this) to house the team-task-manager package and its package dependencies, though this is optional.\r\n####\r\n2. Make sure that your environment has all the required packages installed.\r\n####\r\n3. Next, run the installation syntax presented at the top of [https://pypi.org/project/team-task-manager/](https://pypi.org/project/team-task-manager/) starting with 'pip install'.\r\n####\r\n4. Once the team-task-manager package and the required packages are installed in your environment, assuming you have followed a process resembling the one [here](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/), you should be able to locate team_task_manager.py through the path:\r\n~~~\r\nproject_directory\\.venv\\Lib\\site-packages\\team-task-manager\\team_task_manager.py\r\n~~~\r\n####\r\n5. Open and run team_task_manager.py in your preferred IDE to use the team-task-manager, operated through inputs to the console.\r\n\r\n## How it works\r\n#### When team_task_manager.py is run the following files are generated:\r\n- users.txt - Containing user login information.\r\n- tasks.txt - Containing tasks records. \r\n---\r\n#### After logging in with the default admin credentials:\r\n- username = admin\r\n- password = password \r\n#### The following features are available to the admin:\r\n - Registering new users\r\n - Assigning a new task to a user\r\n - Viewing and modifying all tasks on the system\r\n - Viewing and modifying all tasks assigned to the current user (in this case the admin)\r\n - Generating summary reports as text files\r\n - Displaying the summary reports in the console\r\n - Changing login credentials (though the admin can only change their password)\r\n - Exiting the program\r\n ---\r\n#### After the admin has registered new users, the following features are available to non-admin users:\r\n - Registering new users\r\n - Assigning a new task to a user\r\n - Viewing all tasks on the system\r\n - Viewing and modifying all tasks assigned to the current user\r\n - Changing login credentials\r\n - Exiting the program\r\n## Contributing\r\n\r\nIf you find a bug, have ideas for new features, other improvements, or require more clarity on this project please submit an [issue](https://github.com/a-yh-chew/team-task-manager/issues).\r\n\r\n\r\n\r\n## Author\r\n\r\nAngela Chew (GitHub: [a-yh-chew](https://github.com/a-yh-chew), E-mail: a.yh.chew@gmail.com)\r\n\r\n\r\n## License\r\n\r\n[MIT](https://choosealicense.com/licenses/mit/)\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024, Angela Chew Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "This is a simple task management system small businesses can use.",
"version": "0.0.0",
"project_urls": {
"Homepage": "https://github.com/a-yh-chew/team-task-manager.git",
"Issues": "https://github.com/a-yh-chew/team-task-manager/issues",
"Repository": "https://github.com/a-yh-chew/team-task-manager.git"
},
"split_keywords": [
"team",
"small business",
"task manager"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "53b60283fad9846a00992a3a5b7a8cedeff23b8df234b2e00fa9131b4fec13ca",
"md5": "393a3b07930f224e40681ec65f4cb399",
"sha256": "b90729ad507c79015832d289b395bfdc89335b1af3148d30eb051121889d9a2b"
},
"downloads": -1,
"filename": "team_task_manager-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "393a3b07930f224e40681ec65f4cb399",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 17253,
"upload_time": "2024-03-09T15:54:30",
"upload_time_iso_8601": "2024-03-09T15:54:30.412370Z",
"url": "https://files.pythonhosted.org/packages/53/b6/0283fad9846a00992a3a5b7a8cedeff23b8df234b2e00fa9131b4fec13ca/team_task_manager-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "41e0b496e0c00906fb8326111578edeb7a702065ee9a959d2315963ff3b56893",
"md5": "71081e6712467736673803a314a6617f",
"sha256": "81f5a7dafa4d00856130f56536ca34581ef02ba999cd9027c6b729f8f825a11a"
},
"downloads": -1,
"filename": "team_task_manager-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "71081e6712467736673803a314a6617f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 18020,
"upload_time": "2024-03-09T15:54:31",
"upload_time_iso_8601": "2024-03-09T15:54:31.686569Z",
"url": "https://files.pythonhosted.org/packages/41/e0/b496e0c00906fb8326111578edeb7a702065ee9a959d2315963ff3b56893/team_task_manager-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-09 15:54:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "a-yh-chew",
"github_project": "team-task-manager",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "team-task-manager"
}
