Skip to content

Commit c6cbcf7

Browse files
knight-byteknight-byte
committed
Pypi files added
1 parent 5a9af85 commit c6cbcf7

File tree

9 files changed

+339
-0
lines changed

9 files changed

+339
-0
lines changed

‎.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
bin/*
2+
lib/*
3+
pyvenv.cfg
4+
ums/test/*
5+
ums/__main__.py
6+
ums/**/__pycache__/*

‎dist/ums-0.1.0.tar.gz

11 KB
Binary file not shown.

‎setup.cfg

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[flake8]
2+
max-line-length = 100
3+
4+
[metadata]
5+
description-file = README.md

‎setup.py

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
'''
2+
Author : knight-byte ( Abunachar )
3+
File : setup.py
4+
'''
5+
# --------IMPORTS -------
6+
import setuptools
7+
8+
# -------- SETUP ---------
9+
with open("README.md", "r") as f:
10+
long_description = f.read()
11+
12+
setuptools.setup(
13+
name="ums",
14+
packages=["ums"],
15+
version="0.1.0",
16+
description="LPU UMS api for exacting user data like Profile, annoucement, messages, Timetable, Grades etc.",
17+
long_description_content_type="text/markdown",
18+
long_description=long_description,
19+
url="https://github.com/knight-byte/Ums",
20+
download_url="https://github.com/knight-byte/Ums/archive/v0.1.0.tar.gz",
21+
author="Abunachar Yeahhia",
22+
author_email="abunachar1236@gmail.com",
23+
license="MIT",
24+
classifiers=[
25+
"Intended Audience :: Developers",
26+
"License :: OSI Approved :: MIT License",
27+
"Programming Language :: Python :: 3",
28+
],
29+
keywords=["lpu ums", "ums", "student",
30+
"university management system", "university", "lpu"],
31+
install_requires=["bs4", "requests", "lxml"],
32+
)

‎ums.egg-info/PKG-INFO

Lines changed: 279 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,279 @@
1+
Metadata-Version: 2.1
2+
Name: ums
3+
Version: 0.1.0
4+
Summary: LPU UMS api for exacting user data like Profile, annoucement, messages, Timetable, Grades etc.
5+
Home-page: https://github.com/knight-byte/Ums
6+
Author: Abunachar Yeahhia
7+
Author-email: abunachar1236@gmail.com
8+
License: MIT
9+
Download-URL: https://github.com/knight-byte/Ums/archive/v0.1.0.tar.gz
10+
Description: # UMS
11+
12+
Interact UMS programmatically using a simple Python Library.
13+
Allows User to View User profile, Annoucement, Messages, Datesheet, grades, marks termwise etc.
14+
15+
Do fork and star ⭐ this repository if you like it.
16+
17+
## Contents
18+
19+
- [ Getting Started ](#getting-started)
20+
- [ Methods / Functions ](#Methods)
21+
22+
- [ User Profile ](#user-profile)
23+
- [ Announcements ](#announcements)
24+
- [ Messages ](#Messages)
25+
- [ Grades ](#Grades)
26+
- [ Marks ](#Marks)
27+
- [ Classes ](#Classes)
28+
- [ Datesheet ](#datesheet)
29+
30+
- [ Contribute ](#contribute)
31+
32+
---
33+
34+
## Getting Started
35+
36+
Install this package from pypi
37+
38+
```
39+
$ pip install ums
40+
$ python
41+
>>> from ums import User
42+
>>>
43+
```
44+
45+
---
46+
47+
## Methods
48+
49+
## `See All User Methods/Functions`
50+
51+
### User Profile
52+
53+
- To get User detail
54+
- function Name : `user_profile()`
55+
- This function takes no argument
56+
- This function return a `Dictionary` Object
57+
- `data` : user detail
58+
- `Name` : Name of the User ( dict object )
59+
- `Full Name` : Fullname of User
60+
- `First Name` : First name
61+
- `Middle Name` : Middle name ( if available )
62+
- `Last Name` : Last Name ( if available )
63+
- `RegNo` : Registration Number of user
64+
- `Rollno` : Roll Number of User
65+
- `Term` : Current Term
66+
- `Group` : Class Group
67+
- `Section` : Class section
68+
- `Programme` : User Programme Name
69+
- `Book Issued` : Number of Book user issued from University Library
70+
- `datetime` : timestamp when data is generated
71+
72+
#### Usage
73+
74+
```python
75+
from ums import User
76+
77+
regno = < REGISTRATION NUMBER >
78+
password = < PASSWORD >
79+
user = User(registration=regno, password=password)
80+
81+
profile = user.user_profile()
82+
print(profile)
83+
```
84+
85+
---
86+
87+
### Announcements
88+
89+
- To get all recent annoucements
90+
- Function name : `announcements()`
91+
- This function takes no argument
92+
- This function returns a `Dictionary` object
93+
- `data` : list of all announcement
94+
- `id` : Annoucement Id
95+
- `title` : Title of the announcement
96+
- `body` : Main body of the annoucement
97+
- `media` : list of media attached to the announcement ( if any )
98+
- `datatime` : timestamp when data is generated
99+
100+
#### Usage
101+
102+
```python
103+
from ums import User
104+
105+
regno = < REGISTRATION NUMBER >
106+
password = < PASSWORD >
107+
user = User(registration=regno, password=password)
108+
109+
announcements = user.annoucements()
110+
print(annoucements)
111+
```
112+
113+
---
114+
115+
### Messages
116+
117+
- To get all the recent messages
118+
- Function name : `messages()`
119+
- This function takes no argument
120+
- This function return a `Dictionary` object
121+
- `data` : list of all messages
122+
- `id` : Message Id
123+
- `subject` : Subject of message
124+
- `body` : Main body of the message
125+
- `date` : date of message when published
126+
- `datetime` : timestamp when data is generated
127+
128+
#### Usage
129+
130+
```python
131+
from ums import User
132+
133+
regno = < REGISTRATION NUMBER >
134+
password = < PASSWORD >
135+
user = User(registration=regno, password=password)
136+
137+
messages = user.messages()
138+
print(messages)
139+
```
140+
141+
---
142+
143+
### Grades
144+
145+
- To get Termwise grade
146+
- Function name : `grades()`
147+
- This function takes no argument
148+
- This function return a `Dictionary` Object
149+
- `data` : List of Different term
150+
- `term` : term / semester number
151+
- `tgpa` : term / semester tgpa
152+
- `grades` : List of grades of all subject of that term
153+
- `course` : Course name
154+
- `grade` : grade in that course
155+
- `datetime` : timestamp when data is generated
156+
157+
#### Usage
158+
159+
```python
160+
from ums import User
161+
162+
regno = < REGISTRATION NUMBER >
163+
password = < PASSWORD >
164+
user = User(registration=regno, password=password)
165+
166+
grades = user.grades()
167+
print(grades)
168+
```
169+
170+
---
171+
172+
### Marks
173+
174+
- To get Termwise Marks
175+
- Function name : `marks()`
176+
- This function takes no argument
177+
- This functiom return a `Dictionary` Object
178+
- `data` : List of different term
179+
- `termid` : term id
180+
- `courses` : list of diffeent courses of that term
181+
- `course` : Name of the course
182+
- `marks` : list of different marks of that course
183+
- t`ype : type of mark
184+
- `marks` : list of marks out of different scheme
185+
- `datetime` : timestamp when data is generated
186+
187+
#### Usage
188+
189+
```python
190+
from ums import User
191+
192+
regno = < REGISTRATION NUMBER >
193+
password = < PASSWORD >
194+
user = User(registration=regno, password=password)
195+
196+
marks = user.marks()
197+
print(marks)
198+
```
199+
200+
---
201+
202+
### Classes
203+
204+
- To get all classes of current Day
205+
- Function name : `classes()`
206+
- This function takes no argument
207+
- This function return a `Dictionary` Object
208+
- `data` : List of different Courses
209+
- `course` : Course name
210+
- `timing` : class timing
211+
- `platform` : Class platform
212+
- `status` : current class status of that course
213+
- `datetime` : timestamp when data is generated
214+
215+
#### Usage
216+
217+
```python
218+
from ums import User
219+
220+
regno = < REGISTRATION NUMBER >
221+
password = < PASSWORD >
222+
user = User(registration=regno, password=password)
223+
224+
classes = user.classes()
225+
print(classes)
226+
```
227+
228+
---
229+
230+
### Datesheet
231+
232+
- To get Upcoming Exam Sheet ( if available )
233+
- Function name : `datesheet()`
234+
- This function takes no argument
235+
- This function return a `Dictionary` Object
236+
- `data` : List of different courses
237+
- `id` : Id
238+
- `c_code` : Course Code
239+
- `course` : Course name
240+
- `report` : Reporting timing
241+
- `date` : Exam date
242+
- `timing` : Exam timing
243+
- `datetime` : timestamp when data is generated
244+
245+
#### Usage
246+
247+
```python
248+
from ums import User
249+
250+
regno = < REGISTRATION NUMBER >
251+
password = < PASSWORD >
252+
user = User(registration=regno, password=password)
253+
254+
datesheet = user.datesheet()
255+
print(datesheet)
256+
```
257+
258+
---
259+
260+
## Contribute
261+
262+
- This Project is open for contibution, feel free to contibute new feature, requests and bug fixes
263+
- To contibute fork this repository
264+
- Bug fix / new feature / Optimization :
265+
- Create a new branch
266+
- Makes changes to that branch, create a new Pull request and describe your fixes or addition of new feature
267+
- Feature request :
268+
- Create a new Issue with tag `new feature` and describe your feature you want in upcoming version
269+
270+
---
271+
272+
Made with 💜 in India
273+
274+
Keywords: lpu ums,ums,student,university management system,university,lpu
275+
Platform: UNKNOWN
276+
Classifier: Intended Audience :: Developers
277+
Classifier: License :: OSI Approved :: MIT License
278+
Classifier: Programming Language :: Python :: 3
279+
Description-Content-Type: text/markdown

‎ums.egg-info/SOURCES.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
LICENCE
2+
README.md
3+
setup.cfg
4+
setup.py
5+
ums/__init__.py
6+
ums/__main__.py
7+
ums/ums_main.py
8+
ums.egg-info/PKG-INFO
9+
ums.egg-info/SOURCES.txt
10+
ums.egg-info/dependency_links.txt
11+
ums.egg-info/requires.txt
12+
ums.egg-info/top_level.txt

‎ums.egg-info/dependency_links.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

‎ums.egg-info/requires.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
bs4
2+
requests
3+
lxml

‎ums.egg-info/top_level.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ums

0 commit comments

Comments
 (0)